Fix #1038 - Automatically detect and use htmlhint configuration files

5 files changed, 89 insertions, 5 deletions

diff --git a/ale_linters/html/htmlhint.vim b/ale_linters/html/htmlhint.vim
index e142d22a..88a83f1d 100644
--- a/ale_linters/html/htmlhint.vim
+++ b/ale_linters/html/htmlhint.vim
@@ -1,7 +1,7 @@
 " Author: KabbAmine <amine.kabb@gmail.com>, deathmaz <00maz1987@gmail.com>, diartyz <diartyz@gmail.com>
 " 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_use_global', 0)
 
@@ -12,9 +12,22 @@ function! ale_linters#html#htmlhint#GetExecutable(buffer) abort
 endfunction
 
 function! ale_linters#html#htmlhint#GetCommand(buffer) abort
-    return ale_linters#html#htmlhint#GetExecutable(a:buffer)
-    \   . ' ' . ale#Var(a:buffer, 'html_htmlhint_options')
-    \   . ' %t'
+    let l:options = ale#Var(a:buffer, 'html_htmlhint_options')
+    let l:config = l:options !~# '--config'
+    \   ? 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
 
 call ale#linter#Define('html', {
diff --git a/doc/ale-html.txt b/doc/ale-html.txt
index c5d5afa5..416e932e 100644
--- a/doc/ale-html.txt
+++ b/doc/ale-html.txt
@@ -16,7 +16,7 @@ g:ale_html_htmlhint_executable                 *g:ale_html_htmlhint_executable*
 g:ale_html_htmlhint_options                       *g:ale_html_htmlhint_options*
                                                   *b:ale_html_htmlhint_options*
   Type: |String|
-  Default: `'--format=unix'`
+  Default: `''`
 
   This variable can be changed to modify flags given to HTMLHint.
 
diff --git a/test/command_callback/htmlhint_paths/node_modules/.bin/htmlhint b/test/command_callback/htmlhint_paths/node_modules/.bin/htmlhint
new file mode 100755
index 00000000..e69de29b
--- /dev/null
+++ b/test/command_callback/htmlhint_paths/node_modules/.bin/htmlhint
diff --git a/test/command_callback/htmlhint_paths/with_config/.htmlhintrc b/test/command_callback/htmlhint_paths/with_config/.htmlhintrc
new file mode 100644
index 00000000..e69de29b
--- /dev/null
+++ b/test/command_callback/htmlhint_paths/with_config/.htmlhintrc
diff --git a/test/command_callback/test_htmlhint_command_callback.vader b/test/command_callback/test_htmlhint_command_callback.vader
new file mode 100644
index 00000000..5bb21a6b
--- /dev/null
+++ b/test/command_callback/test_htmlhint_command_callback.vader
@@ -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(''))