vim codeclimate

vim-codéclimat

Un plugin VIM qui exécute le Code Climate CLI et affiche les résultats dans VIM.

Exigences

Le Code climate CLI doit être installé et le binaire codeclimate doit être sur votre PATH .

Installation

Pathogène

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

Vomir

 Plugin 'wfleming/vim-codeclimate'

Usage

 :CodeClimateAnalyzeProject
:CodeClimateAnalyzeOpenFiles
:CodeClimateAnalyzeCurrentFile

Le plugin expose les trois commandes ci-dessus. Par défaut, les raccourcis ne sont pas liés à ces commandes pour éviter d'interférer avec d'autres plugins, mais vous pouvez facilement en ajouter dans votre .vimrc ou init.vim :

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

Variables

CodeClimateAnalyzeOpenFiles et CodeClimateAnalyzeCurrentFile recherchera tous deux des variables de tampon b:codeclimateflags dans les tampons qu'ils analyseront et incluront ceux dans l'invocation du COD climate CLI.

Par exemple, dans un grand projet Web, vous avez probablement de nombreux moteurs différents (pour couvrir vos backend, styles, front-end, etc.), mais pour un fichier donné que vous modifiez la plupart de ces moteurs ne sont probablement pas applicables. En utilisant autocmd , vous pouvez déclarer quels moteurs que vous souhaitez exécuter pour des filetypes spécifiques, ce qui peut aider l'analyse à exécuter sensiblement plus rapidement. À titre d'exemple en béton, j'utilise la configuration suivante pour un projet 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"

Raccourcis clavier

Les raccourcis clavier sont disponibles dans la fenêtre QuickFix, empruntés au plugin 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

Limites

En raison de la façon dont la CLI est exécutée par le plugin, il prévoit de trouver le fichier de configuration .codeclimate.yml dans le répertoire de travail actuel. Vous devrez donc généralement démarrer VIM à partir de la racine de votre référentiel pour que ce plugin fonctionne correctement.