This repo stores my personal Neovim config and related files.

Installation

Recursively clone this repo and its submodules into something like ~/dotfiles/dotnvim, then add a symlink ~/.config/nvim to your local clone of this repo. For example:

mkdir -p ~/dotfiles
cd ~/dotfiles
git clone --recurse-submodules https://github.com/fardaniqbal/dotnvim
# Or git clone --recurse-submodules git@github.com:fardaniqbal/dotnvim.git
# to clone through ssh.
#
# !!! Stop here if you're on Windows !!!

mkdir -p ~/.config
rm -f ~/.config/nvim
ln -s ../dotfiles/dotnvim ~/.config/nvim

Windows Installation

On Windows you can do the above using Git Bash or MSYS 2, but with the following differences:

1. You must enable non-admins to create symlinks. See the following for how to do this:
   • Enable developer mode
   • Allow non-admins to create symlinks
   • Tell git to use symlinks
2. The symlinks must be placed under $LOCALAPPDATA rather than ~/.config:

   # Do this after following the above installation steps, _but stop after
   # the`git clone ...` step_:
   rm -f "$LOCALAPPDATA/nvim"
   ln -s ~/dotfiles/dotnvim "$LOCALAPPDATA/nvim"

Optional Components

The following components aren't required for this setup to work, but they'll be used if they're installed.

• ripgrep - you'll need this for telescope's grep-string (and possibly other telescope functions).
• npm - you'll need this for some of the language servers.
  • Run npm install -g neovim. If you don't have root/admin access, run echo "prefix=$HOME/local/npm-packages" >> ~/.npmrc to make future npm install -g commands install npm packages to your home directory.
• make, gcc, and the usual suspects to build optional plugins.
• For Java integration, you'll need the following executables installed: java, javac, mvn, ant, etc. For example, on MacOS using brew:

  brew install oracle-jdk
  brew install mvn
  brew install ant

  You'll also need JDTLS (Java language server). Run the included install-jdtls.sh script included in this repo to install it.