Ⅰ. 插件描述
The Vim RuboCop plugin runs RuboCop and displays the results in VimⅡ. 基本信息
|
Ⅲ. 安装方法
使用Vundle管理器安装
在你的.vimrc下添加:Plugin 'ngmy/vim-rubocop'
… 然后在Vim中运行以下命令:
:source %
:PluginInstall
对于Vundle版本 < 0.10.2,请用上面的Bundle替换Plugin。
使用NeoBundle管理器安装
在你的.vimrc下添加:NeoBundle 'ngmy/vim-rubocop'
… 然后在Vim中运行以下命令:
:source %
:NeoBundleInstall
使用VimPlug管理器安装
在你的.vimrc下添加:Plug 'ngmy/vim-rubocop'
… 然后在Vim中运行以下命令:
:source %
:PlugInstall
使用Pathogen管理器安装
在终端中运行以下命令:cd ~/.vim/bundle
git clone https://github.com/ngmy/vim-rubocop
Ⅳ. 文档说明
# Vim RuboCop
The Vim RuboCop plugin runs RuboCop and displays the results in Vim.
Requirements
Please note that the current version of the Vim RuboCop plugin requires RuboCop 0.12.0 or later.
Installation
Obtain a copy of this plugin and place rubocop.vim
in your Vim plugin directory.
Usage
You can use the :RuboCop
command to run RuboCop and display the results.
You can also use the :RuboCop
command together with options. For example, :RuboCop -l
, :RuboCop -a
and so on.
Configuration File
To run with the specified configuration file, add the following line to your .vimrc
file:
let g:vimrubocop_config = '/path/to/rubocop.yml'
Keyboard Shortcuts
Credit for Shortcuts: Ack.vim
In the quickfix window, you can use:
o to open (same as enter)
go to preview file (open but maintain focus on ack.vim results)
t to open in new tab
T to open in new tab silently
h to open in horizontal split
H to open in horizontal split silently
v to open in vertical split
gv to open in vertical split silently
q to close the quickfix window
Additionally, the plugin registers <Leader>ru
in normal mode
for triggering it easily. You can disable these default mappings by settingg:vimrubocop_keymap
in your .vimrc
file, and then remap them differently.
For instance, to trigger RuboCop by pressing <Leader>r
you can put the following in
your .vimrc
:
let g:vimrubocop_keymap = 0
nmap <Leader>r :RuboCop<CR>
License
The Vim RuboCop plugin is open-sourced software licensed under the MIT license.