.. | ||
after/syntax | ||
autoload | ||
compiler | ||
doc | ||
ftdetect | ||
ftplugin | ||
indent | ||
plugin | ||
syntax | ||
syntax_checkers/rust | ||
.gitignore | ||
LICENSE-APACHE | ||
LICENSE-MIT | ||
README.md |
rust.vim
Description
This is a Vim plugin that provides Rust file detection, syntax highlighting, formatting, Syntastic integration, and more.
Installation
Using Vundle
- Add
Plugin 'rust-lang/rust.vim'
to~/.vimrc
:PluginInstall
or$ vim +PluginInstall +qall
Note: Vundle will not automatically detect Rust files properly if filetype on
is executed before Vundle. Please check the quickstart for more
details.
Using Pathogen
git clone --depth=1 https://github.com/rust-lang/rust.vim.git ~/.vim/bundle/rust.vim
Using NeoBundle
- Add
NeoBundle 'rust-lang/rust.vim'
to~/.vimrc
- Re-open vim or execute
:source ~/.vimrc
Using vim-plug
- Add
Plug 'rust-lang/rust.vim'
to~/.vimrc
:PlugInstall
or$ vim +PlugInstall +qall
Features
Error checking with Syntastic
rust.vim
automatically registers rustc
as a syntax checker
with Syntastic. Check Syntastic's documentation for
information on how to customize its behaviour.
Formatting with rustfmt
The :RustFmt
command will format your code with
rustfmt if installed.
Placing let g:rustfmt_autosave = 1
in your ~/.vimrc
will
enable automatic running of :RustFmt
when you save a buffer.
Do :help :RustFmt
for further formatting help and customization
options.
Playpen integration
Note: This feature requires webapi-vim to be installed.
The :RustPlay
command will send the current selection, or if
nothing is selected the current buffer, to the Rust playpen.
Help
Further help can be found in the documentation with :Helptags
then :help rust
.
Detailed help can be found in the documentation with :help rust
.
Helptags (:help helptags
) need to be generated for this plugin
in order to navigate the help. Most plugin managers will do this
automatically, but check their documentation if that is not the case.
License
Like Rust, rust.vim is primarily distributed under the terms of both the MIT license and the Apache License (Version 2.0). See LICENSE-APACHE and LICENSE-MIT for details.