*quick-lint-js.txt*	For Vim and Neovim


		QUICK-LINT-JS PLUGIN REFERENCE MANUAL


This file contains instructions for installing and using the quick-lint-js
plugin.

This plugin version is designed for quick-lint-js version 0.3.0. Older or
newer version might or might not work.

1. Installing quick-lint-js	|quick-lint-js-app-install|
2. Installing the plugin	|quick-lint-js-vim-install|
3. Configuring			|quick-lint-js-configure|
   3.1. ALE			|quick-lint-js-configure-ale|

==============================================================================
1. Installing quick-lint-js		*quick-lint-js-app-install*

In order to use the quick-lint-js Vim plugin, you must first install the
quick-lint-js CLI. See this page for instructions on installing the
quick-lint-js CLI for your system:

	https://quick-lint-js.com/install/

==============================================================================
2. Installing the plugin		*quick-lint-js-vim-install*

If you're reading this document, you've probably already installed the
quick-lint-js Vim plugin. If you're not sure, open Vim and run this command: >

	:help quick-lint-js

If you see this documentation, you have already installed the Vim plugin. Go
to the next section, |quick-lint-js-configure|.

If you see error code E149 ("Sorry, no help for quick-lint-js"), then you
need to install the Vim plugin: https://quick-lint-js.com/install/#manual-vim

==============================================================================
3. Configuring 				*quick-lint-js-configure*

After installing the quick-lint-js CLI and the quick-lint-js Vim plugin, you
may need to configure the plugin.

One of the following Vim plugins must be installed and configured in order for
this plugin to work:

* ALE - Asynchronous Lint Engine: |quick-lint-js-configure-ale|
  https://github.com/dense-analysis/ale

==============================================================================
4. Configuring for ALE			*quick-lint-js-configure-ale*

The quick-lint-js Vim plugin comes with a plugin for ALE (Asynchronous Lint
Engine). https://github.com/dense-analysis/ale

Supported ALE versions: v2.1.1 or newer, and v3.0.0 or newer

quick-lint-js is fast. To feel the speed, you should configure
|g:ale_lint_delay|. Add the following code to your |vimrc| to make JavaScript
linting as fast as possible: >

    let g:ale_lint_delay = 0

The quick-lint-js Vim plugin registers an ALE linter called `quick-lint-js`.
If you enable |g:ale_linters_explicit|, add the following code to
`~/.vim/ftplugin/javascript.vim` (UNIX) or
`~/vimfiles/ftplugin/javascript.vim` (Windows) to enable quick-lint-js: >

    let b:ale_linters = ['quick-lint-js']

g:ale_javascript_quick_lint_js_executable
				*g:ale_javascript_quick_lint_js_executable*
				*b:ale_javascript_quick_lint_js_executable*
  Type: |String|
  Default: `'quick-lint-js'`

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

If your quick-lint-js CLI is installed outside your $PATH, add the following
to your |vimrc| file so the Vim plugin knows where to find quick-lint-js: >

    " UNIX:
    let g:ale_javascript_quick_lint_js_executable = '/path/to/quick-lint-js'
    " Windows:
    let g:ale_javascript_quick_lint_js_executable = 'C:\path\to\quick-lint-js.exe'

g:ale_javascript_quick_lint_js_use_global
				*g:ale_javascript_quick_lint_js_use_global*
				*b:ale_javascript_quick_lint_js_use_global*
  Type: |Boolean|
  Default: `v:true`

Set this variable to `v:false` to search for `quick-lint-js` in `node_modules`
first, and if it's not found, use |g:ale_javascript_quick_lint_js_executable|.

Set this variable to `v:true` to only use
|g:ale_javascript_quick_lint_js_executable|.

For security reasons, we recommend leaving this variable at its default value
(`v:true`). If this variable is set to `v:false`, then a malicious project
could run arbitrary code on your computer through `node_modules` if you open a
JavaScript file.

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