## Install for Emacs with npm

Supported operating systems:

Windows instructions

quick-lint-js has an npm package, making it easy to install the LSP server for use by the Emacs plugin.

### Install prerequisites

In order to install quick-lint-js' npm package, you must first install the npm client.

Install one of the following Emacs plugins:

- Eglot (recommended)
- Flymake (included in Emacs version 26 or newer)
- Flycheck
- LSP Mode

### Install quick-lint-js

Install quick-lint-js globally (on your machine) for use anywhere, including the Emacs plugin:

>     sudo npm install --global --unsafe-perm quick-lint-js

Note: The Emacs plugin does not use quick-lint-js if it is installed locally within your project. The Emacs plugin only uses quick-lint-js if it is globally installed.

### Install Emacs plugin

1. Download the quick-lint-js Emacs plugin.
2. Extract `quick-lint-js-emacs.zip`'s files into a directory somewhere safe (for example, `~/.emacs/quick-lint-js-emacs/`).
3. Add the `quick-lint-js-emacs` directory to the Emacs `load-path` variable. For example, add the following line to your init file (e.g. `~/.emacs`):

       (add-to-list 'load-path "~/.emacs/quick-lint-js-emacs")

4. Restart Emacs.

### Configure

Read the Emacs plugin docs online.