Skip to content

Commit c9f1f60

Browse files
committed
Vim: fix documentation regarding node_modules
Apparently, the Vim+ALE plugin automatically loads the file from node_modules. Document this behavior and fix misleading documentation.
1 parent b16a779 commit c9f1f60

File tree

2 files changed

+20
-6
lines changed

2 files changed

+20
-6
lines changed

plugin/vim/quick-lint-js.vim/doc/quick-lint-js.txt

Lines changed: 18 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -79,12 +79,24 @@ g:ale_javascript_quick_lint_js_executable
7979

8080
Set this variable to the path of the quick-lint-js CLI.
8181

82-
If you want to use quick-lint-js installed in a project through NPM, try
83-
adding this to your vimrc file: >
82+
If your quick-lint-js CLI is installed outside your $PATH, add the following
83+
to your |vimrc| file so the Vim plugin knows where to find quick-lint-js: >
8484
85-
" Security risk! Someone might drop a malicious binary into a project.
86-
" Beware!
87-
let g:ale_javascript_quick_lint_js_executable
88-
\ = 'node_modules/.bin/quick-lint-js'
85+
" UNIX:
86+
let g:ale_javascript_quick_lint_js_executable = '/path/to/quick-lint-js'
87+
" Windows:
88+
let g:ale_javascript_quick_lint_js_executable = 'C:\path\to\quick-lint-js.exe'
89+
90+
g:ale_javascript_quick_lint_js_use_global
91+
*g:ale_javascript_quick_lint_js_use_global*
92+
*b:ale_javascript_quick_lint_js_use_global*
93+
Type: |Boolean|
94+
Default: `v:false`
95+
96+
Set this variable to `v:false` to search for `quick-lint-js` in `node_modules`
97+
first, and if it's not found, use |g:ale_javascript_quick_lint_js_executable|.
98+
99+
Set this variable to `v:true` to only use
100+
|g:ale_javascript_quick_lint_js_executable|.
89101

90102
vim:tw=78:ts=8:noet:ft=help:norl:

plugin/vim/quick-lint-js.vim/doc/tags

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
b:ale_javascript_quick_lint_js_executable quick-lint-js.txt /*b:ale_javascript_quick_lint_js_executable*
2+
b:ale_javascript_quick_lint_js_use_global quick-lint-js.txt /*b:ale_javascript_quick_lint_js_use_global*
23
g:ale_javascript_quick_lint_js_executable quick-lint-js.txt /*g:ale_javascript_quick_lint_js_executable*
4+
g:ale_javascript_quick_lint_js_use_global quick-lint-js.txt /*g:ale_javascript_quick_lint_js_use_global*
35
quick-lint-js-app-install quick-lint-js.txt /*quick-lint-js-app-install*
46
quick-lint-js-configure quick-lint-js.txt /*quick-lint-js-configure*
57
quick-lint-js-configure-ale quick-lint-js.txt /*quick-lint-js-configure-ale*

0 commit comments

Comments
 (0)