dotfiles

Repository to store my various .dotfiles. The bash_profile are set to be OS specific. The all_bash_profile provides a generic bash_profile to be used for Linux or Mac OSX. This is then loaded by the specific OS bash_profile files (e.g. osx_bash_profile and linux_bash_profile).

Table of Contents

• How to Install
• Neovim
  • Neovim and iTerm2 on OSX
  • Nvim-R
    • Nvim-R and Tmux
  • ack.vim
• Vim
• Bash
  • hstr
• Base16
  • Base16-vim
  • Base16-iTerm2
  • Base16-shell
• R
• Tmux
• git
• htop
• iTerm2
  • Italics in iTerm2
  • Open iTerm2 tab here
• Docker
• Batch rename files using vim
• Preview markdown files

How to Install

You need to first get homebrew:

/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"

Once this is setup, install wget:

brew install wget

Also, we need to get miniconda.

Once before homebrew and conda are installed, we can clone this repository:

git clone git@github.com:tinyheero/dotfiles.git
cd dotfiles
./install.sh

Neovim

The neovim configuration file requires neovim version > 0.1.4.

If you wish to use vim and not neovim, see below.

You can install neovim through homebrew (OSX):

brew install neovim

If you are installing this on a linux distribution, then you can use the an AppImage. No installation is needed, just download nvim.appimage and run it. For example:

mkdir -p ~/usr/bin/
curl -LO https://github.com/neovim/neovim/releases/download/v0.7.0/nvim.appimage
chmod u+x nvim.appimage
mv nvim.appimage ~/usr/bin
ln -rs ~/usr/bin/nvim.appimage ~/usr/bin/nvim

Neovim and iTerm2 on OSX

There is this weird issue with iTerm2 on OSX where the command ctrl-h doesn't work to switch to the left pane. See this thread for details. The solution is the following inside of iTerm2:

1. Edit -> Preferences -> Keys
2. Press +
3. Press Ctrl+h as Keyboard Shortcut
4. Choose Send Escape Sequence as Action
5. Type [104;5u for Esc

Nvim-R

One amazing plugin is the Nvim-R (formerly known as Vim-R-Plugin) which allows for the integration of Vim and R. This is automatically installed.

If you want to see the stable release, then you can download this here and then get the Nvim-R.vmb open it and then:

:packadd vimball
:so %

Make sure you press the spacebar a few times to make sure everything gets installed.

The plugin depends on an R package called nvimcom (formally known as vimcom). In the past, you would have to download the version that matched specifically with the plugin version you needed. But now, the plugin comes bundled with this package and will automatically install it for you to the R you have in your PATH. Additionally, you don't need to put library("nvimcom") in your ~/.Rprofile because "Nvim-R sets the value of the environment variable R_DEFAULT_PACKAGES, including nvimcom."

If you ever need to install the nvimcom R package again (e.g. if you a different R instance), you can find it at ~/.config/nvim/R/nvimcom. You can install this with:

devtools::install("~/.config/nvim/R/nvimcom")

Nvim-R and Tmux

Nvim-R now contains its own terminal emulator which means it doesn't need tmux anymore. The nvim.vim configuration file is setup to still run tmux as external terminal emulator with the following lines:

let R_in_buffer = 0
let R_tmux_split = 1

This means you need to first start tmux and then launch vim. When you spawn an R session from inside vim, it will create another tmux session that is split in the same window. You can remove the let R_tmux_split = 1 part if you want it to be external.

ack.vim

The ack.vim plugin acts a Vim interface for the programmer's search tool ack. You need to install ack in order for the plugin to work.

The best way is to use your system package managers or you can do it manually:

# Assumes your ${HOME}/usr/bin folder is in your PATH environment variable.
curl https://beyondgrep.com/ack-2.24-single-file \
        > "${HOME}/usr/bin/ack" \
        && chmod 0755 "${HOME}/usr/bin/ack";

This happens in the install_linux_sofware.sh script.

Using ack.vim with Ag (the_silver_searcher )

The ack.vim plugin can also be used with Ag (the_silver_searcher). The nvim.init is already configured to use Ag if it is available using the following lines:

" Use ag in the background for the ack.vim plugin
if executable('ag')
  let g:ackprg = 'ag --vimgrep'
endif

In other to use Ag with ack.vim, you will need to install it. You can do this on Mac OSX using homebrew:

brew install the_silver_searcher

Or on Centos using yum:

yum install the_silver_searcher

A cool tip I learned from the video 07 - Plugins - The power of :Ag is using Ag (directly) to search and replace for a given string across all the files in your project.

:args `ag -l string_to_replace .`
:argdo %s/string_to_search/replacement_string/g | w

What about ag.vim?

Confusingly, the ag.vim plugin, which was orginally designed to be the front for the_silver_searcher has been deprecated (see this comment for more details). As such, do not use it.

Vim

If you don't want to use neovim, then you can also just use base vim. You can use all the plugins that are listed above. To set this up,

curl -fLo ~/.vim/autoload/plug.vim --create-dirs \
    https://raw.githubusercontent.com/junegunn/vim-plug/master/plug.vim

Then open vim, and run:

:PlugInstall

Bash

hstr

The bash_profile uses hstr. This can be used on Centos:

sudo yum install hstr -y

On Mac OSX, this is replaced with the fzf.

Base16

We use the Base16 color guideslines for vim, shell and the iterm2 terminal.

• base16-vim
• base16-iterm2
• base16-shell

In order to get everything working, you must install all 3 base16 color implementations.

Base16-vim

This is automatically installed when you run :PlugInstall inside vim.

Base16-iTerm2

To install the base16-iterm2, simply go to the github page download the appropriate color scheme you need. In this case, this would be base16-default.dark.256.itermcolors. Then in iterm2:

1. Go to Preferences > Profiles > Colors
2. Click on Color Presets... (bottom right) > Import and import your the base16-default.dark.256.itermcolors file.

Base16-shell

The base16-shell implementation can be installed using:

git clone https://github.com/chriskempson/base16-shell.git ~/.config/base16-shell

Inside the bash_profile file, there is a line:

BASE16_SHELL="$HOME/.config/base16-shell/scripts/base16-default-dark.sh"
[[ "$-" == *i* ]] && [[ -s $BASE16_SHELL ]] && source $BASE16_SHELL

This simply ensures that the correct bash16-shell color theme is loaded. In this case, we want it to the base16-default-dark.

R

The Rprofile file configures what should be loaded in R when R is first started. One of the packages that is automatically loaded is the colorout package. This is unfortunately not available from CRAN and would need to be installed manually. Using devtools also works:

devtools::install_github("jalvesaq/colorout")

Starting a new R project

For starting a new R project, you can use the setup_r_proj.R script:

~/dotfiles/setup_r_proj.R

This will automatically install the following R packages:

• nvimcom
• colorout

Tmux

The tmux.conf is setup such that the prefix is switched from <C-b> to <C-a>. This is so that it is concordant with the default binding used in screen, which what I switched from. It is also setup to allow for copying from inside a tmux session using vi commands. By installing reattach-to-user-namespace:

brew install reattach-to-user-namespace --with-wrap-pbcopy-and-pbpaste

The text will be copied into the system clipboard. You may or may not need to also select "Applications in terminal may access clipboard" inside iTerm2 -> Preferences (see this link for more details). This may only be with mouse copying though. The workflow for this is as follows:

C-a escape # to enter copy mode
v # visual selection
q # to escape copy mode

Then you can copy using command-p as per usual as the text is copied into the OS clipboard.

Git

Autocompletion of git commands and branches is setup. See this article for more details.

htop

Htop is a nicer version of top. You can get it by running:

brew install htop

iTerm2

Italics in iTerm2

To get italics in iTerm2, follow these instructions.

Open iTerm2 tab here

Sometimes you need to open the current folder in iTerm2 to do some quick linux commands. On OSX, one can use the automator and applescript for this. See this snippet of code for more details.

Docker

To get tab completion for Docker commands, see this link.

Batch rename files using vim

https://github.com/thameera/vimv

Preview markdown files

To preview your markdown files, you can use Grip (GitHub Readme Instant Preview) for this. You can install this using homebrew:

brew install grip

Then you can run:

grip -b README.md 

This will automatically preview the README file in a new browser tab.

Keep in mind this previews using Github markdown specification.