Skip to content

Commit

Permalink
erblint as fixer (#3935)
Browse files Browse the repository at this point in the history
* fixer erblint

* erblint fixer test
  • Loading branch information
roelandm authored Oct 11, 2021
1 parent 1ee7580 commit 7413dfd
Show file tree
Hide file tree
Showing 4 changed files with 100 additions and 0 deletions.
5 changes: 5 additions & 0 deletions autoload/ale/fix/registry.vim
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,11 @@ let s:default_registry = {
\ 'suggested_filetypes': ['nim'],
\ 'description': 'Apply nimpretty to a file.',
\ },
\ 'erblint': {
\ 'function': 'ale#fixers#erblint#Fix',
\ 'suggested_filetypes': ['eruby'],
\ 'description': 'Apply erblint --autocorrect to a file.',
\ },
\ 'eslint': {
\ 'function': 'ale#fixers#eslint#Fix',
\ 'suggested_filetypes': ['javascript', 'typescript'],
Expand Down
40 changes: 40 additions & 0 deletions autoload/ale/fixers/erblint.vim
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
" Author: Roeland Moors - https://github.com/roelandmoors
" Description: ERB Lint, support for https://github.com/Shopify/erb-lint

call ale#Set('eruby_erblint_executable', 'erblint')
call ale#Set('eruby_erblint_options', '')


" Erblint fixer outputs diagnostics first and then the fixed
" output. These are delimited by something like this:
" ================ /path/to/demo.html.erb ==================
" We only need the output after this
function! ale#fixers#erblint#PostProcess(buffer, output) abort
let l:line = 0

for l:output in a:output
let l:line = l:line + 1

if l:output =~# "^=\\+.*=\\+$"
break
endif
endfor

return a:output[l:line :]
endfunction

function! ale#fixers#erblint#GetCommand(buffer) abort
let l:executable = ale#Var(a:buffer, 'eruby_erblint_executable')
let l:options = ale#Var(a:buffer, 'eruby_erblint_options')

return ale#ruby#EscapeExecutable(l:executable, 'erblint')
\ . (!empty(l:options) ? ' ' . l:options : '')
\ . ' --autocorrect --stdin %s'
endfunction

function! ale#fixers#erblint#Fix(buffer) abort
return {
\ 'command': ale#fixers#erblint#GetCommand(a:buffer),
\ 'process_with': 'ale#fixers#erblint#PostProcess'
\}
endfunction
55 changes: 55 additions & 0 deletions test/fixers/test_erblint_fixer_callback.vader
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
Before:
Save g:ale_eruby_erblint_executable
Save g:ale_eruby_erblint_options

" Use an invalid global executable, so we don't match it.
let g:ale_eruby_erblint_executable = 'xxxinvalid'
let g:ale_eruby_erblint_options = ''

call ale#test#SetDirectory('/testplugin/test/fixers')

After:
Restore

call ale#test#RestoreDirectory()

Execute(The erblint callback should return the correct default values):
call ale#test#SetFilename('../test-files/eruby/dummy.html.erb')

AssertEqual
\ {
\ 'process_with': 'ale#fixers#erblint#PostProcess',
\ 'command': ale#Escape(g:ale_eruby_erblint_executable)
\ . ' --autocorrect --stdin %s',
\ },
\ ale#fixers#erblint#Fix(bufnr(''))

Execute(The erblint callback should include custom erblint options):
let g:ale_eruby_erblint_options = '--lint-all'
call ale#test#SetFilename('../test-files/ruby/with_config/dummy.rb')

AssertEqual
\ {
\ 'process_with': 'ale#fixers#erblint#PostProcess',
\ 'command': ale#Escape(g:ale_eruby_erblint_executable)
\ . ' --lint-all'
\ . ' --autocorrect --stdin %s',
\ },
\ ale#fixers#erblint#Fix(bufnr(''))

Execute(The erblint post-processor should remove diagnostics content):
AssertEqual
\ [
\ '<div>',
\ '',
\ '</div>',
\ ],
\ ale#fixers#erblint#PostProcess(bufnr(''), [
\ 'Linting 1 files with 11 autocorrectable linters...',
\ '',
\ '1 error(s) corrected in ERB files',
\ '================ /home/user/demo.html.erb ==================',
\ '<div>',
\ '',
\ '</div>',
\ ])
Empty file.

0 comments on commit 7413dfd

Please sign in to comment.