Install for Vim with npm
Supported operating systems:
quick-lint-js has an npm package, making it easy to install the LSP server for use by the Vim plugin.
1. Install prerequisites
In order to install quick-lint-js' npm package, you must first install the npm client.
Install and configure one of the following Vim plugins:
- ALE - Asynchronous Lint Engine v2.1.1 or newer, or version v3.0.0 or newer
- coc.nvim - Conquer of Completion v0.0.80 or newer
2. Install quick-lint-js
Install quick-lint-js globally (on your machine) for use anywhere, including the Vim plugin:
sudo npm install --global --unsafe-perm quick-lint-js
Note: The Vim plugin does not use quick-lint-js if it is installed locally within your project. The Vim plugin only uses quick-lint-js if it is globally installed.
3. Install Vim plugin
Install this plugin with your favorite Vim packaging system:
Choose a Vim package manager above to get started!
Install as a Vim package
This option requires Vim 8.0 or newer.
- Download the quick-lint-js Vim plugin.
-
Add
packloadallto your~/.vimrcfile if not already present. -
Create the directory
~/.vim/pack/external/start/. -
Copy the extracted
quick-lint-js.vimdirectory into the~/.vim/pack/external/start/directory. - Restart Vim.
Install with Pathogen
This option requires Pathogen.
- Download the quick-lint-js Vim plugin.
-
Copy the extracted
quick-lint-js.vimdirectory into the~/.vim/bundle/directory. - Restart Vim.
Install with Vim-Plug
This option requires Vim-Plug.
-
Add the following line to your
vimrcfile betweencall plug#begin(...)andcall plug#end():Plug 'quick-lint/quick-lint-js', {'rtp': 'plugin/vim/quick-lint-js.vim', 'tag': '3.0.0'} - Restart Vim.
- In Vim, run
:PlugInstall.
Install with Vundle
This option requires Vundle.
Using Vundle is not recommended. Vundle doesn't support version pinning. We recommend using a different Vim plugin manager.
-
Add the following line to your
vimrcfile betweencall vundle#begin(...)andcall vundle#end():Plugin 'quick-lint/quick-lint-js', {'rtp': 'plugin/vim/quick-lint-js.vim'} - Restart Vim.
- In Vim, run
:PluginInstall.
4. Configure
Configure the Vim plugin by opening Vim and running :help quick-lint-js, or read the Vim plugin docs online.