Install quick-lint-js
Latest version: 0.2.0 (beta) (released )
* The LSP
server is not installed globally with this installation method, so
some editors might not be able to access it.
CLI
and LSP server
Install the quick-lint-js CLI, which includes the LSP server:
Vim plugin
Install the quick-lint-js Vim plugin:
npm
Supported operating systems:
quick-lint-js has an
npm package,
making it easy to install the CLI in your JavaScript project.
In order to install quick-lint-js' npm package, you must first install
either the
npm client
or yarn.
There are two ways to install quick-lint-js: within a project, or
globally.
Install within project
Install quick-lint-js within a project so anyone can use it when
hacking on your project:
GNU/Linux and
macOS with npm
npm install quick-lint-js --save-dev --save-exact
node_modules/.bin/quick-lint-js --help
GNU/Linux and
macOS with yarn
yarn add quick-lint-js --dev --exact
node_modules/.bin/quick-lint-js --help
Windows with
npm
npm install quick-lint-js --save-dev --save-exact
node_modules\.bin\quick-lint-js.cmd --help
Windows with
yarn
yarn add quick-lint-js --dev --exact
node_modules\.bin\quick-lint-js.cmd --help
Install globally
Install quick-lint-js globally (on your machine) for use anywhere:
GNU/Linux and
macOS
sudo npm install --global --unsafe-perm quick-lint-js
quick-lint-js --help
Windows
npm install --global quick-lint-js
quick-lint-js.cmd --help
Homebrew
Supported operating systems:
quick-lint-js has a Homebrew formula, making it easy to install the
CLI and LSP server on macOS.
In order to install quick-lint-js' Homebrew formula, you must first
install Homebrew.
Then, open a terminal, and run the following command to add
quick-lint-js' tap to your Homebrew installation:
brew tap quick-lint/quick-lint-js https://github.com/quick-lint/quick-lint-js.git
Finally, in the terminal, run the following command to install
quick-lint-js:
brew install --HEAD quick-lint-js
Now the CLI, called quick-lint-js, is available in your
user path:
quick-lint-js --help
Debian
and
Ubuntu
Supported operating systems:
Open a terminal, and run the following commands:
curl https://c.quick-lint-js.com/quick-lint-js-release.key | sudo apt-key add -
printf '\n# https://quick-lint-js.com/install.html#debian\ndeb https://c.quick-lint-js.com/debian experimental main\n' | sudo tee -a /etc/apt/sources.list.d/quick-lint-js.list
sudo apt-get update
#
CLI and LSP server
sudo apt-get install quick-lint-js
#
Vim plugin
sudo apt-get install quick-lint-js-vim
Verify that quick-lint-js is installed:
quick-lint-js --version
quick-lint-js version 0.2.0
Nix
Supported operating systems:
In order to install quick-lint-js' Nix package, you must first install
Nix or
NixOS.
Open a terminal, and run the following command:
nix-env -f https://github.com/quick-lint/quick-lint-js/archive/0.2.0.tar.gz -iA quick-lint-js
Now the CLI, called quick-lint-js
, is available in your
user profile:
quick-lint-js --version
quick-lint-js version 0.2.0
Visual
Studio Code marketplace
Supported operating systems:
quick-lint-js has a Visual Studio Code extension on the marketplace.
Visit the
quick-lint-js extension
page, then click the Install button.
Alternatively, open Visual Studio Code, open the Extensions panel, and
search for quick-lint-js.
Manual (pre-built)
Supported operating systems:
CLI and LSP server
-
Download the latest release of quick-lint-js for your platform:
- Extract the downloaded archive.
-
Copy the extracted
quick-lint-js/bin/quick-lint-js
(GNU/Linux or macOS) or
bin\quick-lint-js.exe
(Windows) file into a directory
in your PATH
.
For example, copy it into the
/usr/local/bin
(GNU/Linux or macOS) or
C:\Windows\System32\
(Windows) directory.
-
Open a terminal or PowerShell window or Command Prompt window. Type
quick-lint-js --version and press enter to verify the
installation succeeded.
Visual
Studio Code extension
quick-lint-js has a Visual Studio Code extension. To install it
manually (without the marketplace):
-
Download the latest release of the quick-lint-js extension.
- Open Visual Studio Code.
- Open the Extensions panel.
-
Click the "..." icon to open the
Views and More Actions... menu.
- Choose Install from VSIX....
-
Select the downloaded
quick-lint-js-0.2.0.vsix
file.
The extension is self-contained. You do not need to also install the
quick-lint-js CLI or LSP server.
Vim plugin
Supported operating systems:
Prerequisites
-
Install the quick-lint-js CLI using one of the following methods:
-
Install and configure one of the following Vim plugins:
Installation
Install this plugin with your favorite Vim packaging system:
Install as a Vim package
This option requires Vim 8.0 or newer.
GNU/Linux and
macOS
-
Download the quick-lint-js Vim plugin.
-
Add
packloadall
to your
~/.vimrc
file if not already present.
-
Create the directory
~/.vim/pack/external/start/
.
-
Copy the extracted
quick-lint-js.vim
directory into the
~/.vim/pack/external/start/
directory.
- Restart Vim.
Windows
-
Download the quick-lint-js Vim plugin.
-
Add
packloadall
to your
%USERPROFILE%\_vimrc
file (or
%USERPROFILE%\vimfiles\vimrc
) if not already present.
-
Create the directory
%USERPROFILE%\vimfiles\pack\external\start\
.
-
Copy the extracted
quick-lint-js.vim
directory into the
%USERPROFILE%\vimfiles\pack\external\start\
directory.
- Restart Vim.
Install with Pathogen
This option requires
Pathogen.
GNU/Linux and
macOS
-
Download the quick-lint-js Vim plugin.
-
Copy the
quick-lint-js.vim
directory into
~/.vim/bundle/
directory.
- Restart Vim.
Install with Vim-Plug
This option requires
Vim-Plug.
-
Add the following line to your
vimrc
file between
call plug#begin(...)
and
call plug#end()
:
Plug 'strager/quick-lint-js', {'rtp': 'plugin/vim/quick-lint-js.vim'}
- Restart Vim.
- In Vim, run
:PlugInstall
.
Install with Vundle
This option requires
Vundle.
-
Add the following line to your
vimrc
file between
call vundle#begin(...)
and
call vundle#end()
:
Plugin 'strager/quick-lint-js', {'rtp': 'plugin/vim/quick-lint-js.vim'}
- Restart Vim.
- In Vim, run
:PluginInstall
.