If you want to learn about Vim in general, check out Thoughtbot's Upcase Learn Vim tutorial.
Obviously this setup works for me, a mainstream Ruby developer on macOS, and this particular setup may or may not work for you. If this particular setup doesn't work for you, please steal ideas from this and if you like, contribute back tips, tricks, and other tidbits via Pull Requests if you like!
First, you may want to backup any existing files that exist so this doesn't overwrite your work.
Run install/backup.sh to backup all symlinked files to a ~/dotfiles-backup directory.
This will not delete any of these files, and the install scripts will not overwrite any existing. After the backup is complete, you can delete the files from your home directory to continue installation.
If on OSX, you will need to install the XCode CLI tools and brew before continuing. To do so, open a terminal and type
xcode-select --installInstall brew from https://docs.brew.sh/Installation
Add Homebrew to your path
echo 'eval "$(/opt/homebrew/bin/brew shellenv)"' >> Users/<your username>/.zprofile eval "$(/opt/homebrew/bin/brew shellenv)"
Then, clone the dotfiles repository to your home directory as ~/.dotfiles.
➜ mkdir -p ~/Code/lua && cd ~/Code/lua
➜ git clone --recursive https://github.com/kaka-ruto/neodotfiles.git
➜ cd ~/neodotfiles
➜ ./install.shinstall.sh will start by initializing the submodules used by this repository (if any). Read through this file and comment out anything you don't want installed. Then, it will install all symbolic links into your home directory. Every file with a .symlink extension will be symlinked to the home directory with a . in front of it.
Additionally, all files in the $DOTFILES/config directory will be symlinked to the ~/.config/ directory for applications that follow the XDG base directory specification, such as neovim.
It also downloads Astronvim into ~/.config/nvim and my personal Astronvim configuration into ~/.config/nvim/lua/user
Next, the install script will perform a check to see if it is running on an OSX machine. If so, it will install Homebrew if it is not currently installed and will install the homebrew packages listed in brew.sh. Then, it will run osx.sh and change some OSX configurations. This file is pretty well documented and so it is advised that you read through and comment out any changes you do not want. Next, nginx (installed from Homebrew) will be configured with the provided configuration file. If a nginx.conf file already exists in /usr/local/etc, a backup will be made at /usr/local/etc/nginx/nginx.conf.original.
ZSH is configured in the zshrc.symlink file, which will be symlinked to the home directory. The following occurs in this file:
- set the
EDITORto nvim - Load any
~/.terminfosetup - Set the
CODE_DIRvariable, pointing to the location where the code projects exist for exclusive autocompletion with theccommand - Recursively search the
$DOTFILES/zshdirectory for files ending in .zsh and source them - Setup zplug plugin manager for zsh plugins and installed them.
- source a
~/.localrcif it exists so that additional configurations can be made that won't be kept track of in this dotfiles repo. This is good for things like API keys, etc. - Add the
~/binand$DOTFILES/bindirectories to the path - And more...
The prompt is meant to be simple while still providing a lot of information to the user, particularly about the status of the git project, if the PWD is a git project. This prompt sets precmd, PROMPT and RPROMPT. The precmd shows the current working directory in it and the RPROMPT shows the git and suspended jobs info. The main symbol used on the actual prompt line is ❯.
The prompt attempts to speed up certain information lookups by allowing for the prompt itself to be asynchronously rewritten as data comes in. This prevents the prompt from feeling sluggish when, for example, the user is in a large git repo and the git prompt commands take a considerable amount of time.
It does this by writing the actual text that will be displayed int he prompt to a temp file, which is then used to update the prompt information when a signal is trapped.
The git info shown on the RPROMPT displays the current branch name, along with the following symbols.
+- New files were added!- Existing files were modified?- Untracked files exist that are not ignored»- Current changes include file renaming✘- An existing tracked file has been deleted$- There are currently stashed files=- There are unmerged files⇡- Branch is ahead of the remote (indicating a push is needed)⇣- Branch is behind the remote (indicating a pull is needed)⇕- The branches have diverged (indicating history has changed and maybe a force-push is needed)✔- The current working directory is clean
The prompt will also display a ✱ character in the RPROMPT indicating that there is a suspended job that exists in the background. This is helpful in keeping track of putting vim in the background by pressing CTRL-Z.
If a package.json file or a node_modules directory exists in the current working directory, display the node symbol, along with the current version of Node. This is useful information when switching between projects that depend on different versions of Node.
Neovim is a fork and drop-in replacement for vim. in most cases, you would not notice a difference between the two, other than Neovim allows plugins to run asynchronously so that they do not freeze the editor, which is the main reason I have switched over to it. Vim and Neovim both use Vimscript and most plugins will work in both (all of the plugins I use do work in both Vim and Neovim). For this reason, they share the same configuration files in this setup. Neovim uses the XDG base directory specification which means it won't look for a .vimrc in your home directory. Instead, its configuration looks like the following:
| Vim | Neovim | |
|---|---|---|
| Main Configuratin File | ~/.vimrc |
~/.config/nvim/init.vim |
| Configuration directory | ~/.vim |
~/.config/nvim |
Vim is likely already installed on your system. If using a Mac, MacVim will be installed from Homebrew. Neovim will also be installed from Homebrew by default on a Mac. For other systems, you may need to install Neovim manually. See their web site for more information.
link.sh will symlink the XDG configuration directory into your home directory and will then create symlinks for .vimrc and .vim over to the Neovim configuration
so that Vim and Neovim will both be configured in the same way from the same files.
Inside of .zshrc, the EDITOR shell variable is set to nvim, defaulting to Neovim for editor tasks, such as git commit messages. Additionally, I have aliased vim to nvim in aliases.zsh You can remove this if you would rather not alias the vim command to nvim.
vim and neovim should just work once the correct plugins are installed. To install the plugins, you will need to open Neovim in the following way:
nvimI am currently using Operator Mono as my default font which is a paid font ($199 US) and does not include Powerline support. You do not need this font at all and there is nothing directly referencing it in the setup. For a great, free programming font, check out Mozilla's Fira. In addition to this, I do have nerd-fonts installed and configured to be used for non-ascii characters via iTerm2's profile settings. If you would prefer not to do this, then simply remove the Plug 'ryanoasis/vim-devicons' plugin from vim/nvim.
Tmux is a terminal multiplexor which lets you create windows and splits in the terminal that you can attach and detach from. I use it to keep multiple projects open in separate windows and to create an IDE-like environment to work in where I can have my code open in vim/neovim and a shell open to run tests/scripts. Tmux is configured in ~/.tmux.conf, and in tmux/theme.sh, which defines the colors used, the layout of the tmux bar, and what what will be displayed, including the time and date, open windows, tmux session name, computer name, and current iTunes song playing. If not running on macOS, this configuration should be removed.
When tmux starts up, login-shell will be run and if it determines you are running this on macOS, it will call reattach-to-user-namespace, to fix the system clipboard for use inside of tmux.
I also user tmuxinator to manage my different project's tmux sessions.
You can find my tmuxinator config files in config/tmuxinator/
Press prefix + I (capital i) to install configured tmux plugins such as tmux-resurrect and tmux-yank.
I have required files in the folder neodotfiles, and astronvim configuration at neodotfiles/config/astronvim, where astronvim is a git submodule with it's own git repository
To make changes to the astronvim submodule, make them as you would any file, and then, if you're making the changes from within the neodotfiles dir, don't commit astronvim changes from here.
Switch to the astronvim dir and commit and push there, which will push to the astronvim repo on Github
Then switch back to your neodotfiles dir and git add the astronvim changes and also make a second commit. This second commit will be set to track the recently commited changes you made to astronvim.
And now if you push, from within the neoditfiles dir, it will create a commit showing what changed in the astronvim folder and point to the astronvim dir!