summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDevon Meunier <devon.meunier@shopify.com>2017-05-16 11:47:35 -0400
committerDevon Meunier <devon.meunier@shopify.com>2017-05-16 14:07:52 -0400
commit9ca51ed035d1fb3cefe28efe0dea60fbe71b4048 (patch)
treeeeb5a61c545ec85f84c9aafde4b29fbce5da4c13
parent8712aee5dcddd366ae52a0c57e67fdbc13c030ee (diff)
downloadale-9ca51ed035d1fb3cefe28efe0dea60fbe71b4048.zip
Allow overriding rubocop executable.
-rw-r--r--ale_linters/ruby/rubocop.vim16
-rw-r--r--doc/ale-ruby.txt9
-rw-r--r--test/command_callback/test_rubocop_command_callback.vader29
3 files changed, 52 insertions, 2 deletions
diff --git a/ale_linters/ruby/rubocop.vim b/ale_linters/ruby/rubocop.vim
index 95cb5516..d1286f75 100644
--- a/ale_linters/ruby/rubocop.vim
+++ b/ale_linters/ruby/rubocop.vim
@@ -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',
\})
diff --git a/doc/ale-ruby.txt b/doc/ale-ruby.txt
index cbbb1322..6e8aa0eb 100644
--- a/doc/ale-ruby.txt
+++ b/doc/ale-ruby.txt
@@ -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|
diff --git a/test/command_callback/test_rubocop_command_callback.vader b/test/command_callback/test_rubocop_command_callback.vader
new file mode 100644
index 00000000..96a63ce6
--- /dev/null
+++ b/test/command_callback/test_rubocop_command_callback.vader
@@ -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(''))