Merge pull request #561 from meunierd/override-rubocop-executable

Allow overriding rubocop executable.
This commit is contained in:
w0rp 2017-05-18 09:19:23 +01:00 committed by GitHub
commit 2fd4db91ce
3 changed files with 47 additions and 2 deletions

View File

@ -25,20 +25,37 @@ function! ale_linters#ruby#rubocop#Handle(buffer, lines) abort
endfunction
function! ale_linters#ruby#rubocop#GetCommand(buffer) abort
return 'rubocop --format emacs --force-exclusion '
let l:unescaped = ale#Var(a:buffer, 'ruby_rubocop_executable')
let l:executable = ale#Escape(l:unescaped)
if l:unescaped =~? 'bundle$'
let l:executable = l:executable . ' exec rubocop'
endif
return l:executable
\ . ' --format emacs --force-exclusion '
\ . ale#Var(a:buffer, 'ruby_rubocop_options')
\ . ' --stdin ' . bufname(a:buffer)
endfunction
function! ale_linters#ruby#rubocop#GetExecutable(buffer) abort
let l:executable = ale#Var(a:buffer, 'ruby_rubocop_executable')
if executable(l:executable)
return l:executable
endif
endfunction
" Set this option to change Rubocop options.
if !exists('g:ale_ruby_rubocop_options')
" let g:ale_ruby_rubocop_options = '--lint'
let g:ale_ruby_rubocop_options = ''
endif
if !exists('g:ale_ruby_rubocop_executable')
let g:ale_ruby_rubocop_executable = 'rubocop'
endif
call ale#linter#Define('ruby', {
\ 'name': 'rubocop',
\ 'executable': 'rubocop',
\ 'executable_callback': 'ale_linters#ruby#rubocop#GetExecutable',
\ 'command_callback': 'ale_linters#ruby#rubocop#GetCommand',
\ 'callback': 'ale_linters#ruby#rubocop#Handle',
\})

View File

@ -37,6 +37,15 @@ g:ale_ruby_reek_show_wiki_link *g:ale_ruby_reek_show_wiki_link*
-------------------------------------------------------------------------------
rubocop *ale-ruby-rubocop*
g:ale_ruby_rubocop_executable g:ale_ruby_rubocop_executable
b:ale_ruby_rubocop_executable
Type: String
Default: 'rubocop'
Override the invoked rubocop binary. This is useful for running rubocop
from binstubs or a bundle.
g:ale_ruby_rubocop_options *g:ale_ruby_rubocop_options*
*b:ale_ruby_rubocop_options*
Type: |String|

View File

@ -0,0 +1,19 @@
Before:
runtime ale_linters/ruby/rubocop.vim
Execute(Executable should default to rubocop):
AssertEqual
\ '''rubocop'' --format emacs --force-exclusion --stdin ''dummy.py''',
\ ale_linters#ruby#rubocop#GetCommand(bufnr(''))
Execute(Should be able to set a custom executable):
let g:ale_ruby_rubocop_executable = 'bin/rubocop'
AssertEqual
\ '''bin/rubocop'' --format emacs --force-exclusion --stdin ''dummy.py''',
\ ale_linters#ruby#rubocop#GetCommand(bufnr(''))
Execute(Setting bundle appends 'exec rubocop'):
let g:ale_ruby_rubocop_executable = 'path to/bundle'
AssertEqual
\ '''path to/bundle'' exec rubocop --format emacs --force-exclusion --stdin ''dummy.py''',
\ ale_linters#ruby#rubocop#GetCommand(bufnr(''))