[eruby] Add GetCommand to erb linter
GetCommand conditionally adds a filter (implemented as inline Ruby code in the command line) to transform some of the problematic Rails-specific eRuby syntax. Specifically, <%= tags are replaced with <%. This does not reduce the effectiveness of the linter, because the transformed code is still evaluated. This solution was suggested by @rgo at https://github.com/w0rp/ale/issues/580#issuecomment-337676607.
This commit is contained in:
parent
e9e29e003c
commit
ea7f68226e
3 changed files with 38 additions and 3 deletions
|
@ -1,11 +1,25 @@
|
||||||
" Author: Matthias Guenther - https://wikimatze.de
|
" Author: Matthias Guenther - https://wikimatze.de, Eddie Lebow https://github.com/elebow
|
||||||
" Description: ERB from the Ruby standard library, for eruby/erb files
|
" Description: ERB from the Ruby standard library, for eruby/erb files
|
||||||
|
|
||||||
|
function! ale_linters#eruby#erb#GetCommand(buffer) abort
|
||||||
|
let l:rails_root = ale#ruby#FindRailsRoot(a:buffer)
|
||||||
|
|
||||||
|
if empty(l:rails_root)
|
||||||
|
return 'erb -P -x %t | ruby -c'
|
||||||
|
endif
|
||||||
|
|
||||||
|
" Rails-flavored eRuby does not comply with the standard as understood by
|
||||||
|
" ERB, so we'll have to do some substitution. This does not reduce the
|
||||||
|
" effectiveness of the linter—the translated code is still evaluated.
|
||||||
|
return 'ruby -r erb -e ' . ale#Escape('puts ERB.new($stdin.read.gsub(%{<%=},%{<%}), nil, %{-}).src') . ' | ruby -c'
|
||||||
|
endfunction
|
||||||
|
|
||||||
call ale#linter#Define('eruby', {
|
call ale#linter#Define('eruby', {
|
||||||
\ 'name': 'erb',
|
\ 'name': 'erb',
|
||||||
|
\ 'aliases': ['erubylint'],
|
||||||
\ 'executable': 'erb',
|
\ 'executable': 'erb',
|
||||||
\ 'output_stream': 'stderr',
|
\ 'output_stream': 'stderr',
|
||||||
\ 'command': 'erb -P -x %t | ruby -c',
|
\ 'command_callback': 'ale_linters#eruby#erb#GetCommand',
|
||||||
\ 'callback': 'ale#handlers#ruby#HandleSyntaxErrors',
|
\ 'callback': 'ale#handlers#ruby#HandleSyntaxErrors',
|
||||||
\})
|
\})
|
||||||
|
|
||||||
|
|
21
test/command_callback/test_erb_command_callback.vader
Normal file
21
test/command_callback/test_erb_command_callback.vader
Normal file
|
@ -0,0 +1,21 @@
|
||||||
|
Before:
|
||||||
|
runtime ale_linters/eruby/erb.vim
|
||||||
|
call ale#test#SetDirectory('/testplugin/test/command_callback')
|
||||||
|
|
||||||
|
After:
|
||||||
|
call ale#linter#Reset()
|
||||||
|
call ale#test#RestoreDirectory()
|
||||||
|
|
||||||
|
Execute(Executable should not contain any filter code by default):
|
||||||
|
call ale#test#SetFilename('../ruby_fixtures/not_a_rails_app/file.rb')
|
||||||
|
|
||||||
|
AssertEqual
|
||||||
|
\ 'erb -P -x %t | ruby -c',
|
||||||
|
\ ale_linters#eruby#erb#GetCommand(bufnr(''))
|
||||||
|
|
||||||
|
Execute(Executable should filter invalid eRuby when inside a Rails project):
|
||||||
|
call ale#test#SetFilename('../ruby_fixtures/valid_rails_app/app/views/my_great_view.html.erb')
|
||||||
|
|
||||||
|
AssertEqual
|
||||||
|
\ 'ruby -r erb -e ' . ale#Escape('puts ERB.new($stdin.read.gsub(%{<%=},%{<%}), nil, %{-}).src') . ' | ruby -c',
|
||||||
|
\ ale_linters#eruby#erb#GetCommand(bufnr(''))
|
Reference in a new issue