Rust IDE + REPL In Vim

Kade Killary · 2017.12.30 · 4 minutes until it's over

rust-ide

Rust is a fascinating language filled with novel ideas. However, the tooling around the language is still maturing. The seemingly best option for writing Rust appears to be Visual Studio Code with the RLS plugin. It’s a nice setup, but I think there is a slightly more optimal solution utilizing Vim. This post will detail this layout.

Rust Support

First up is getting basic support for Rust. Luckily, the Rust team makes this easy with rust-lang/rust.vim. The rust.vim plugin adds the usual: file detection, syntax highlighting, formatting, etc…

One novel feature of the plugin is automatic rustfmt on save.

let g:autofmt_autosave = 1

LSP

After establishing basic support, the next step is getting access to the RLS. In order to do this you’ll need a plugin to communicate with the language server. In Vim there is Vim-Lsp and for Neovim LanguageClient-Neovim - also works with Vim.

" a basic set up for LanguageClient-Neovim

" << LSP >> {{{

let g:LanguageClient_autoStart = 0
nnoremap <leader>lcs :LanguageClientStart<CR>

" if you want it to turn on automatically
" let g:LanguageClient_autoStart = 1

let g:LanguageClient_serverCommands = {
    \ 'python': ['pyls'],
    \ 'rust': ['rustup', 'run', 'nightly', 'rls'],
    \ 'javascript': ['javascript-typescript-stdio'],
    \ 'go': ['go-langserver'] }

noremap <silent> H :call LanguageClient_textDocument_hover()<CR>
noremap <silent> Z :call LanguageClient_textDocument_definition()<CR>
noremap <silent> R :call LanguageClient_textDocument_rename()<CR>
noremap <silent> S :call LanugageClient_textDocument_documentSymbol()<CR>
" }}}

Completions

Another core component to this setup is a completion manager. Neovim has nvim-completion-manager - a great choice, while Vim has YouCompleteMe or Completer.

RLS

Now we are starting to get to the meaty part - the RLS, or Rust Language Server. A brief description from the repo is below.

The RLS provides a server that runs in the background, providing IDEs, editors, and other tools with information about Rust programs. It supports functionality such as ‘goto definition’, symbol search, reformatting, and code completion, and enables renaming and refactorings.

The RLS gets its source data from the compiler and from Racer. Where possible it uses data from the compiler which is precise and complete. Where its not possible, (for example for code completion and where building is too slow), it uses Racer.

The installation process is easy enough.

# get rustup
# don't use hombrew
curl https://sh.rustup.rs -sSf | sh

rustup self update

# get nightly compiler
rustup update nightly

# after nightly installed
rustup component add rls-preview --toolchain nightly
rustup component add rust-analysis --toolchain nightly
rustup component add rust-src --toolchain nightly

After that, you’ll pass in the commands to your LSP plugin of choice. An example config for LanguageClient-Neovim is provided below.

let g:LanguageClient_serverCommands = {
    \ 'rust': ['rustup', 'run', 'nightly', 'rls']
}

Opening a Rust file should now look analogous to below.

completion

RUSTI

Last but certainly not least, Rusti. This solution isn’t a silver bullet. Yet, it provides something quite unique to Rust development - a REPL. This small quirk is great for quickly verifying an idea. And for myself, has made learning Rust significantly easier.

To get Rusti follow these steps:

# Rusti builds with Rust nightly, using the Cargo build system.
# Currently, it must be built using a nightly release of the Rust compiler released no later than 2016-08-01.
rustup install nightly-2016-08-01

# install rusti using cargo
rustup run nightly-2016-08-01 cargo install --git https://github.com/murarth/rusti

# next up we'll alias the run command
# set up in .bashrc or .zshrc
alias rrepl="rustup run nightly-2016-08-01 ~/.cargo/bin/rusti"

Rusti Workflow:

BONUS

One last thing to note, that may or may not be obvious depending on your Vim knowledge, is executing cargo commands in Vim. Specifically :! cargo run and the like.