Ⅰ. 插件描述
Vim configuration for Rust.Ⅱ. 基本信息
|
Ⅲ. 安装方法
使用Vundle管理器安装
在你的.vimrc下添加:Plugin 'rust-lang/rust-vim-superman'
… 然后在Vim中运行以下命令:
:source %
:PluginInstall
对于Vundle版本 < 0.10.2,请用上面的Bundle替换Plugin。
使用NeoBundle管理器安装
在你的.vimrc下添加:NeoBundle 'rust-lang/rust-vim-superman'
… 然后在Vim中运行以下命令:
:source %
:NeoBundleInstall
使用VimPlug管理器安装
在你的.vimrc下添加:Plug 'rust-lang/rust-vim-superman'
… 然后在Vim中运行以下命令:
:source %
:PlugInstall
使用Pathogen管理器安装
在终端中运行以下命令:cd ~/.vim/bundle
git clone https://github.com/rust-lang/rust.vim
Ⅳ. 文档说明
# rust.vim
Description
This is a Vim plugin that provides Rust file detection, syntax highlighting, formatting,
Syntastic integration, and more. It requires Vim 8 or higher for full functionality.
Some things may not work on earlier versions.
Installation
Use one of the following package managers:
git clone https://github.com/rust-lang/rust.vim ~/.vim/pack/plugins/start/rust.vim
- 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
- Add
- Errors such as
Not an editor command: RustFmt
may occur if Vundle - misconfigured with this plugin.
git clone --depth=1 https://github.com/rust-lang/rust.vim.git ~/.vim/bundle/rust.vim
- Add
Plug 'rust-lang/rust.vim'
to~/.vimrc
:PlugInstall
or$ vim +PlugInstall +qall
- Add
- Add
call dein#add('rust-lang/rust.vim')
to~/.vimrc
:call dein#install()
- Add
- Add
NeoBundle 'rust-lang/rust.vim'
to~/.vimrc
- Re-open vim or execute
:source ~/.vimrc
- Add
Features
Error checking with Syntastic
rust.vim
automatically registers cargo
as a syntax checker with
Syntastic, if nothing else is specified. See :help rust-syntastic
for more details.
Source browsing with Tagbar
The installation of Tagbar along with Universal Ctags is recommended
for a good Tagbar experience. For other kinds of setups, rust.vim
tries to
configure Tagbar to some degree.
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.
If you set g:rust_clip_command RustPlay will copy the url to the clipboard.
- Mac:
let g:rust_clip_command = 'pbcopy'
- Linux:
let g:rust_clip_command = 'xclip -selection clipboard'
Running a test under cursor
In cargo project, the :RustTest
command will run a test under the cursor.
This is useful when your project is bigger and running all tests take longer time.
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.