Merge pull request #142 from w0rp/use-local-jshint-program

Add node_modules support for JSHint, and use the global config as a fallback

2 files changed, 41 insertions, 10 deletions

diff --git a/ale_linters/javascript/jshint.vim b/ale_linters/javascript/jshint.vim
index 327158a8..f82011dd 100644
--- a/ale_linters/javascript/jshint.vim
+++ b/ale_linters/javascript/jshint.vim
@@ -4,17 +4,31 @@
 let g:ale_javascript_jshint_executable =
 \   get(g:, 'ale_javascript_jshint_executable', 'jshint')
 
-function! ale_linters#javascript#jshint#GetCommand(buffer)
-    " Set this to the location of the jshint configuration file to
-    " use a fixed location for .jshintrc
-    if exists('g:ale_jshint_config_loc')
-        let l:jshint_config = g:ale_jshint_config_loc
-    else
-        " Look for the JSHint config in parent directories.
-        let l:jshint_config = ale#util#FindNearestFile(a:buffer, '.jshintrc')
+let g:ale_javascript_jshint_use_global =
+\   get(g:, 'ale_javascript_jshint_use_global', 0)
+
+function! ale_linters#javascript#jshint#GetExecutable(buffer) abort
+    if g:ale_javascript_jshint_use_global
+        return g:ale_javascript_jshint_executable
     endif
 
-    let l:command = g:ale_javascript_jshint_executable . ' --reporter unix'
+    return ale#util#ResolveLocalPath(
+    \   a:buffer,
+    \   'node_modules/.bin/jshint',
+    \   g:ale_javascript_jshint_executable
+    \)
+endfunction
+
+function! ale_linters#javascript#jshint#GetCommand(buffer)
+    " Search for a local JShint config locaation, and default to a global one.
+    let l:jshint_config = ale#util#ResolveLocalPath(
+    \   a:buffer,
+    \   '.jshintrc',
+    \   get(g:, 'ale_jshint_config_loc', '')
+    \)
+
+    let l:command = ale_linters#javascript#jshint#GetExecutable(a:buffer)
+    let l:command .= ' --reporter unix'
 
     if !empty(l:jshint_config)
         let l:command .= ' --config ' . fnameescape(l:jshint_config)
@@ -27,7 +41,7 @@ endfunction
 
 call ale#linter#Define('javascript', {
 \   'name': 'jshint',
-\   'executable': g:ale_javascript_jshint_executable,
+\   'executable_callback': 'ale_linters#javascript#jshint#GetExecutable',
 \   'command_callback': 'ale_linters#javascript#jshint#GetCommand',
 \   'callback': 'ale#handlers#HandleUnixFormatAsError',
 \})
diff --git a/doc/ale.txt b/doc/ale.txt
index c879a98b..52702b2b 100644
--- a/doc/ale.txt
+++ b/doc/ale.txt
@@ -399,8 +399,25 @@ g:ale_javascript_jshint_executable         *g:ale_javascript_jshint_executable*
   Type: |String|
   Default: `'jshint'`
 
+  ALE will first discover the jshint path in an ancestor node_modules
+  directory. If no such path exists, this variable will be used instead.
+
   This variable can be changed to change the path to jshint.
 
+  If you wish to use only a globally installed version of jshint, set
+  |g:ale_javascript_jshint_use_global| to `1`.
+
+
+g:ale_javascript_jshint_use_global         *g:ale_javascript_jshint_use_global*
+
+  Type: |String|
+  Default: `0`
+
+  This variable controls whether or not ALE will search for a local path for
+  jshint first. If this variable is set to `1`, then ALE will always use the
+  global version of jshint, in preference to locally installed versions of
+  jshint in node_modules.
+
 
 -------------------------------------------------------------------------------
 4.3. phpcs                                           *ale-linter-options-phpcs*