Running VimClojure in eclimd

VimClojure is set of plugins for vim which provide various features for working with clojure. When running the bundled nailgun server it can provide interactive features like code completion, repl interaction, etc. While VimClojure can be used independently of eclim, you can also embed VimClojure’s nailgun server inside of eclim via eclim’s ext dir support. By doing so, you only have to run a single nailgun server, as opposed to running one for eclim and another for VimClojure.

To install VimClojure and embed it into eclim, simply follow these steps:

Note

In this guide we keep VimClojure as self contained as possible instead of copying all of its vim files into your vimfiles directory. While this isn’t required, it can make upgrading or removing VimClojure easier.

1. First download the VimClojure distribution.

2. Next, unpack the distribution into your vim files directory:

   Linux, BSD, OSX:

   $ cd ~/.vim
   $ unzip ~/vimclojure-2.1.2.zip

   Windows:

   > cd %HOME%\vimfiles
   > jar -xvf %HOME%\Desktop\vimclojure-2.1.2.zip

3. Then build vimclojure:

   $ cd vimclojure-2.1.2
   $ ant

4. Then copy the VimClojure jars into eclim’s ext dir:

   Linux, BSD, OSX:

   $ mkdir ~/.eclim/resources/ext/vimclojure
   $ cp {build/vimclojure.jar,lib/clojure*.jar} ~/.eclim/resources/ext/vimclojure

   Windows users, your can just create the %HOME%\.eclim\resources\ext\vimclojure directory and copy the jar files from the build and lib dirs via Windows Explorer.

5. Lastely, configure vim:

   Linux, BSD, OSX:

   $ cp ftdetect/clojure.vim ~/.vim/ftdetect/

   Windows:

   > cp ftdetect\clojure.vim %HOME%\vimfiles\ftdetect

   Add the following to your vimrc file:

   Linux, BSD, OSX:

   set rtp+=~/.vim/vimclojure-2.1.2
   

   Windows:

   set rtp+=~/vimfiles/vimclojure-2.1.2
   

   Create a new clojure ftplugin file to configure vimclojure:

   Linux, BSD, OSX:

   $ mkdir ~/.vim/ftplugin/clojure
   $ vim ~/.vim/ftplugin/clojure/clojure.vim

   Windows:

   > mkdir %HOME%\vimfiles\ftplugin\clojure
   > gvim %HOME%\vimfiles\ftplugin\clojure\clojure.vim

   ftplugin/clojure/clojure.vim contents:

   let g:clj_want_gorilla = 1
   let vimclojure#NailgunClient =
     \ eclim#client#nailgun#GetNgCommand() .
     \ ' --nailgun-port ' . eclim#client#nailgun#GetNgPort()
   

Once you have completed the above steps, then you just need to restart eclimd and then all of VimClojure’s features should be available to you while editing a clojure source file in vim.