Skip to content

Setup editors

Oxlint editor extensions start the language server with oxlint --lsp from your project installation, so oxlint must be installed in the project.

See Quickstart to install and run Oxlint from the command line.

Supported editors

VS Code

Install

Download the official Oxc VS Code extension from:

The extension is compatible with other VS Code-based editors, including Cursor.

  1. Recommend the extension in your repository so contributors install the same tooling.

Create .vscode/extensions.json:

json
{
  "recommendations": ["oxc.oxc-vscode"]
}
  1. Enable fix-on-save (optional).

Add to .vscode/settings.json:

jsonc
{
  "editor.codeActionsOnSave": {
    "source.fixAll.oxc": true,
  },
}
  1. Enable type-aware linting (optional).

If you'd like to use type-aware rules and show type-related lint violations, ensure that typeAware is set to true in your VS Code settings (.vscode/settings.json):

jsonc
{
  "oxc.typeAware": true,
}

You also need to ensure oxlint-tsgolint is installed in your project. See the type-aware linting docs for more details.

Usage and configuration reference

Zed

Install

Use

Configure the extension in Zed’s settings.json (workspace or user settings), then open your project as a folder/workspace.

Usage and configuration reference


JetBrains

IntelliJ IDEA and WebStorm

Install

Use

Install the plugin, restart the IDE, and open your repository as a project.

Usage and configuration reference

coc.nvim

Install

vim
:CocInstall coc-oxc

Usage and configuration reference

Other editors

If your editor supports custom LSP configuration (Neovim LSP, Emacs, Helix, Sublime LSP, etc.), configure it to launch:

bash
oxlint --lsp

Reference (language server implementation and issues)

Released under the MIT License.