vim codeclimate

Vim-codeclima

Um plug -in VIM que executa o clima climático do código e exibe os resultados no VIM.

Requisitos

A CLI climática do código deve ser instalada e o binário codeclimate deve estar em seu PATH .

Instalação

Patógeno

 $ git clone https://github.com/wfleming/vim-codeclimate ~/.vim/bundle/vim-codeclimate.com

Vundle

 Plugin 'wfleming/vim-codeclimate'

Uso

 :CodeClimateAnalyzeProject
:CodeClimateAnalyzeOpenFiles
:CodeClimateAnalyzeCurrentFile

O plug -in expõe os três comandos acima. Por padrão, nenhum atalho está vinculado a esses comandos para evitar interferir em outros plugins, mas você pode adicionar facilmente alguns no seu .vimrc ou init.vim :

 nmap <Leader>aa :CodeClimateAnalyzeProject<CR>
nmap <Leader>ao :CodeClimateAnalyzeOpenFiles<CR>
nmap <Leader>af :CodeClimateAnalyzeCurrentFile<CR>

Variáveis

CodeClimateAnalyzeOpenFiles e CodeClimateAnalyzeCurrentFile procurará as variáveis ​​de buffer b:codeclimateflags nos buffers que analisarão e incluirão aqueles na convocação da CLI climática do código.

Por exemplo, em um grande projeto da Web, é provável que você tenha muitos motores diferentes ativados (para cobrir seu back-end, estilos, front-end etc.), mas para qualquer arquivo que você esteja editando, a maioria desses motores provavelmente não é aplicável. Ao usar autocmd , você pode declarar quais motores você deseja executar para filetipos específicos, o que pode ajudar a análise a executar visivelmente mais rápido. Como exemplo concreto, uso a seguinte configuração para um projeto Ruby on Rails:

 autocmd FileType javascript let b:codeclimateflags="--engine eslint"
autocmd FileType ruby let b:codeclimateflags="--engine rubocop"
autocmd FileType scss let b:codeclimateflags="--engine scss-lint"

Atalhos de teclado

Os atalhos de teclado estão disponíveis na janela Quickfix, emprestados do plug -in ACK.VIM.

 ?    a quick summary of these keys, repeat to close
o    to open (same as Enter)
O    to open and close the quickfix window
go   to preview file, open but maintain focus on results
t    to open in new tab
T    to open in new tab without moving to it
h    to open in horizontal split
H    to open in horizontal split, keeping focus on the results
v    to open in vertical split
gv   to open in vertical split, keeping focus on the results
q    to close the quickfix window

Limitações

Devido à forma como a CLI é executada pelo plug -in, espera encontrar o arquivo de configuração .codeclimate.yml no diretório de trabalho atual. Portanto, você geralmente precisa iniciar o VIM da raiz do seu repositório para que este plug -in funcione corretamente.