Fix #1038 - Automatically detect and use htmlhint configuration files

This commit is contained in:
w0rp 2018-01-28 12:44:42 +00:00
parent 7ef55a8615
commit 65fc5d11c7
5 changed files with 89 additions and 5 deletions

View File

@ -1,7 +1,7 @@
" Author: KabbAmine <amine.kabb@gmail.com>, deathmaz <00maz1987@gmail.com>, diartyz <diartyz@gmail.com> " Author: KabbAmine <amine.kabb@gmail.com>, deathmaz <00maz1987@gmail.com>, diartyz <diartyz@gmail.com>
" Description: HTMLHint for checking html files " Description: HTMLHint for checking html files
call ale#Set('html_htmlhint_options', '--format=unix') call ale#Set('html_htmlhint_options', '')
call ale#Set('html_htmlhint_executable', 'htmlhint') call ale#Set('html_htmlhint_executable', 'htmlhint')
call ale#Set('html_htmlhint_use_global', 0) call ale#Set('html_htmlhint_use_global', 0)
@ -12,9 +12,22 @@ function! ale_linters#html#htmlhint#GetExecutable(buffer) abort
endfunction endfunction
function! ale_linters#html#htmlhint#GetCommand(buffer) abort function! ale_linters#html#htmlhint#GetCommand(buffer) abort
return ale_linters#html#htmlhint#GetExecutable(a:buffer) let l:options = ale#Var(a:buffer, 'html_htmlhint_options')
\ . ' ' . ale#Var(a:buffer, 'html_htmlhint_options') let l:config = l:options !~# '--config'
\ . ' %t' \ ? ale#path#FindNearestFile(a:buffer, '.htmlhintrc')
\ : ''
if !empty(l:config)
let l:options .= ' --config ' . ale#Escape(l:config)
endif
if !empty(l:options)
let l:options = substitute(l:options, '--format=unix', '', '')
endif
return ale#Escape(ale_linters#html#htmlhint#GetExecutable(a:buffer))
\ . (!empty(l:options) ? ' ' . l:options : '')
\ . ' --format=unix %t'
endfunction endfunction
call ale#linter#Define('html', { call ale#linter#Define('html', {

View File

@ -16,7 +16,7 @@ g:ale_html_htmlhint_executable *g:ale_html_htmlhint_executable*
g:ale_html_htmlhint_options *g:ale_html_htmlhint_options* g:ale_html_htmlhint_options *g:ale_html_htmlhint_options*
*b:ale_html_htmlhint_options* *b:ale_html_htmlhint_options*
Type: |String| Type: |String|
Default: `'--format=unix'` Default: `''`
This variable can be changed to modify flags given to HTMLHint. This variable can be changed to modify flags given to HTMLHint.

View File

View File

@ -0,0 +1,71 @@
Before:
Save g:ale_html_htmlhint_options
Save g:ale_html_htmlhint_executable
Save g:ale_html_htmlhint_use_global
unlet! g:ale_html_htmlhint_options
unlet! g:ale_html_htmlhint_executable
unlet! g:ale_html_htmlhint_use_global
runtime ale_linters/html/htmlhint.vim
call ale#test#SetDirectory('/testplugin/test/command_callback')
call ale#test#SetFilename('htmlhint_paths/test.html')
let g:node_executable = ale#path#Simplify(
\ g:dir
\ . '/htmlhint_paths/node_modules/.bin/htmlhint'
\)
let g:config_path = ale#path#Simplify(
\ g:dir
\ . '/htmlhint_paths/with_config/.htmlhintrc'
\)
After:
Restore
unlet! g:node_executable
unlet! g:config_path
call ale#test#RestoreDirectory()
call ale#linter#Reset()
Execute(The default command should be correct):
AssertEqual
\ ale#Escape(g:node_executable) . ' --format=unix %t',
\ ale_linters#html#htmlhint#GetCommand(bufnr(''))
Execute(The global executable should be uesd if the option is set):
let g:ale_html_htmlhint_executable = 'foo'
let g:ale_html_htmlhint_use_global = 1
AssertEqual
\ ale#Escape('foo') . ' --format=unix %t',
\ ale_linters#html#htmlhint#GetCommand(bufnr(''))
" This is so old configurations which might include this still work.
Execute(--format=unix should be removed from the options if added):
let g:ale_html_htmlhint_options = '--format=unix'
AssertEqual
\ ale#Escape(g:node_executable) . ' --format=unix %t',
\ ale_linters#html#htmlhint#GetCommand(bufnr(''))
Execute(The configuration file should be automatically detected):
call ale#test#SetFilename('htmlhint_paths/with_config/test.html')
AssertEqual
\ ale#Escape(g:node_executable)
\ . ' --config ' . ale#Escape(g:config_path)
\ . ' --format=unix %t',
\ ale_linters#html#htmlhint#GetCommand(bufnr(''))
" This is so old configurations which might include the config will work.
Execute(The configuration file should be configurable through the options variable):
call ale#test#SetFilename('htmlhint_paths/with_config/test.html')
let g:ale_html_htmlhint_options = '--config=/foo/bar/.htmlhintrc'
AssertEqual
\ ale#Escape(g:node_executable)
\ . ' --config=/foo/bar/.htmlhintrc'
\ . ' --format=unix %t',
\ ale_linters#html#htmlhint#GetCommand(bufnr(''))