vim codeclimate

Vim-Codeklima

Ein VIM -Plugin, das die Code -Klima -CLI ausführt und die Ergebnisse in VIM anzeigt.

Anforderungen

Die Code -Klima -CLI muss installiert werden und die codeclimate -Binärin muss sich auf Ihrem PATH befinden.

Installation

Erreger

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

Vundel

 Plugin 'wfleming/vim-codeclimate'

Verwendung

 :CodeClimateAnalyzeProject
:CodeClimateAnalyzeOpenFiles
:CodeClimateAnalyzeCurrentFile

Das Plugin enthält die drei obigen Befehle. Standardmäßig sind keine Verknüpfungen .vimrc diese Befehle gebunden, um zu vermeiden init.vim dass andere Plugins gestört werden.

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

Variablen

CodeClimateAnalyzeOpenFiles & CodeClimateAnalyzeCurrentFile werden sowohl nach Puffer-Level b:codeclimateflags Variablen in den Puffern suchen, die sie analysieren, und diejenigen in den Aufruf des Code-Klima-CLI einbeziehen.

In einem großen Webprojekt können Sie beispielsweise viele verschiedene Motoren aktivieren (um Ihr Backend, Stile, Front-End usw. abzudecken). Für eine bestimmte Datei, die Sie mit den meisten dieser Motoren bearbeiten, sind jedoch wahrscheinlich nicht zutreffend. Durch die Verwendung von autocmd können Sie erklären, welche Motoren Sie für bestimmte Filetypen ausführen möchten. Dadurch können die Analyse dabei helfen, merklich schneller zu werden. Als konkretes Beispiel verwende ich die folgende Konfiguration für ein Ruby on Rails -Projekt:

 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"

Tastaturverknüpfungen

Tastaturverknüpfungen sind im QuickFix -Fenster erhältlich, das vom ACK.VIM -Plugin ausgeliehen wird.

 ?    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

Einschränkungen

Aufgrund der Art und Weise, wie die CLI vom Plugin ausgeführt wird, wird erwartet, dass die Konfigurationsdatei .codeclimate.yml im aktuellen Arbeitsverzeichnis ermittelt wird. So müssen Sie im Allgemeinen VIM aus dem Stammpunkt Ihres Repositorys starten, damit dieses Plugin ordnungsgemäß funktioniert.