quick-lint-js

quick-lint-js finds bugs in JavaScript programs.

Install quick-lint-js

Latest version: 0.2.0 (beta) (released )

Install method Operating systems
CLI
LSP server
VS Code
extension

Vim
plugin
 npm  *  †
 Homebrew
 Debian
 Ubuntu
 Nix
 Arch Linux
 VS Code
marketplace
 Open VSX
Manual (pre-built)  *
Manual (Vim plugin)
Manual (source)

* This installation method might not install extras such as documentation or shell completion plugins.

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:

 GNU/Linux

 macOS

 Windows

 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 quick-lint-js

Now the CLI, called quick-lint-js, is available in your user path:

quick-lint-js --help

Configure the Vim plugin by opening Vim and running :help quick-lint-js.

 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/#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

Configure the Vim plugin by opening Vim and running :help quick-lint-js.

 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

 Arch Linux

Supported operating systems:

quick-lint-js has two packages in the AUR:

If you are using an AUR helper, install quick-lint-js on Arch Linux using your helper. For example, to install with yay, open a terminal and run the following commands:

yay -Sy quick-lint-js

If you want to install without an AUR helper, download and install the package from AUR manually by running the following commands:

pacman -Sy base-devel git
git clone https://aur.archlinux.org/quick-lint-js.git aur-quick-lint-js
cd aur-quick-lint-js
makepkg -si

Configure the Vim plugin by opening Vim and running :help quick-lint-js.

 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. If the Install button is missing, copy the Installation command, open Visual Studio Code, press CTRL-P (Linux or Windows) or CMD-P (macOS), then paste the copied command.

Alternatively, open Visual Studio Code, open the Extensions panel, and search for quick-lint-js.

 Open VSX

Supported operating systems:

quick-lint-js has a VSCodium extension on the Open VSX registry.

Open VSCodium, open the Extensions panel, and search for quick-lint-js.

Alternatively, install the extension manually:

  1. Visit the quick-lint-js extension page.
  2. Click the Download button.
  3. Open VSCodium.
  4. Open the Extensions panel.
  5. Click the "..." to open a menu.
  6. Select Install from VSIX....
  7. Choose the quick-lint.quick-lint-js-0.2.0.vsix file you downloaded.

Manual (pre-built)

Supported operating systems:

 CLI and LSP server

  1. Download the latest release of quick-lint-js for your platform:
  2. Extract the downloaded archive.
  3. 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.

  4. 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):

  1. Download the latest release of the quick-lint-js extension.
  2. Open Visual Studio Code.
  3. Open the Extensions panel.
  4. Click the "..." icon to open the Views and More Actions... menu.
  5. Choose Install from VSIX....
  6. 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

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
  1. Download the quick-lint-js Vim plugin.
  2. Add packloadall to your ~/.vimrc file if not already present.
  3. Create the directory ~/.vim/pack/external/start/.
  4. Copy the extracted quick-lint-js.vim directory into the ~/.vim/pack/external/start/ directory.
  5. Restart Vim.
 Windows
  1. Download the quick-lint-js Vim plugin.
  2. Add packloadall to your %USERPROFILE%\_vimrc file (or %USERPROFILE%\vimfiles\vimrc) if not already present.
  3. Create the directory %USERPROFILE%\vimfiles\pack\external\start\.
  4. Copy the extracted quick-lint-js.vim directory into the %USERPROFILE%\vimfiles\pack\external\start\ directory.
  5. Restart Vim.

Install with Pathogen

This option requires Pathogen.

 GNU/Linux and  macOS
  1. Download the quick-lint-js Vim plugin.
  2. Copy the quick-lint-js.vim directory into ~/.vim/bundle/ directory.
  3. Restart Vim.

Install with Vim-Plug

This option requires Vim-Plug.

  1. Add the following line to your vimrc file between call plug#begin(...) and call plug#end():
    Plug 'quick-lint/quick-lint-js', {'rtp': 'plugin/vim/quick-lint-js.vim'}
  2. Restart Vim.
  3. In Vim, run :PlugInstall.

Install with Vundle

This option requires Vundle.

  1. Add the following line to your vimrc file between call vundle#begin(...) and call vundle#end():
    Plugin 'quick-lint/quick-lint-js', {'rtp': 'plugin/vim/quick-lint-js.vim'}
  2. Restart Vim.
  3. In Vim, run :PluginInstall.

Configuring

Configure the Vim plugin by opening Vim and running :help quick-lint-js, or read the Vim plugin docs online.