Allow overriding rubocop executable.

This commit is contained in:
Devon Meunier 2017-05-16 11:47:35 -04:00
parent 8712aee5dc
commit 9ca51ed035
3 changed files with 52 additions and 2 deletions

View file

@ -25,20 +25,32 @@ function! ale_linters#ruby#rubocop#Handle(buffer, lines) abort
endfunction
function! ale_linters#ruby#rubocop#GetCommand(buffer) abort
return 'rubocop --format emacs --force-exclusion '
return ale#Var(a:buffer, 'ruby_rubocop_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 = split(ale#Var(a:buffer, 'ruby_rubocop_executable'))[0]
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,29 @@
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(Custom executables should not be escaped):
let g:ale_ruby_rubocop_executable = 'bundle exec rubocop'
AssertEqual
\ 'bundle exec rubocop --format emacs --force-exclusion --stdin ''dummy.py''',
\ ale_linters#ruby#rubocop#GetCommand(bufnr(''))
Execute(Executable callback should return the first token of the executable):
let g:ale_ruby_rubocop_executable = 'bundle exec rubocop'
AssertEqual
\ 'bundle',
\ ale_linters#ruby#rubocop#GetExecutable(bufnr(''))
let g:ale_ruby_rubocop_executable = 'bin/rubocop'
AssertEqual
\ 'bin/rubocop',
\ ale_linters#ruby#rubocop#GetExecutable(bufnr(''))