Início rápido

Configuração recomendada e comandos mais usados, prontos para copiar.

Instalar

oxlint como dependência de desenvolvimento:

npm

$ npm add -D oxlint

pnpm

$ pnpm add -D oxlint

yarn

$ yarn add -D oxlint

bun

$ bun add -D oxlint

Scripts no package.json:

package.json

{
  "scripts": {
    "lint": "oxlint",
    "lint:fix": "oxlint --fix"
  }
}

Rodar:

npm

npm run lint

pnpm

pnpm run lint

yarn

yarn run lint

bun

bun run lint

Aplicar correções:

npm

npm run lint:fix

pnpm

pnpm run lint:fix

yarn

yarn run lint:fix

bun

bun run lint:fix

Uso

Lista completa em referência CLI.

oxlint [OPÇÕES] [CAMINHO]...

Sem CAMINHO, o Oxlint linta o diretório atual.

Fluxos comuns

Pré-commit com lint-staged

npm

{
  "lint-staged": {
    "*.{js,jsx,ts,tsx,mjs,cjs}": "npm run lint"
  }
}

pnpm

{
  "lint-staged": {
    "*.{js,jsx,ts,tsx,mjs,cjs}": "pnpm run lint"
  }
}

yarn

{
  "lint-staged": {
    "*.{js,jsx,ts,tsx,mjs,cjs}": "yarn run lint"
  }
}

bun

{
  "lint-staged": {
    "*.{js,jsx,ts,tsx,mjs,cjs}": "bun run lint"
  }
}

Criar config

Gerar .oxlintrc.json com valores padrão:

oxlint --init

Personalize .oxlintrc.json; veja Configuração.

Também existe oxlint.config.ts; detalhes em Configuração — TS.

Depois:

oxlint

TIP

Vindo do ESLint, leia Migrar do ESLint.

Correções seguras vs avançadas

Correções seguras:

oxlint --fix

Sugestões (podem mudar comportamento):

oxlint --fix-suggestions

Correções perigosas:

oxlint --fix-dangerously

Quando usar cada modo: Correções automáticas.

Ignorar arquivos

Arquivo dedicado:

oxlint --ignore-path .oxlintignore

Padrões na CLI:

oxlint --ignore-pattern "dist/**" --ignore-pattern "*.min.js"

Desligar ignores:

oxlint --no-ignore

Mais em Ignorar arquivos.

CI confiável

Só erros:

oxlint --quiet

Erro se houver qualquer warning:

oxlint --deny-warnings

Limite de warnings:

oxlint --max-warnings 0

CI.

Saída para máquina

oxlint -f json

Formatos: default, json, unix, checkstyle, github, gitlab, junit, stylish. Formatos de saída.

Inspecionar config efetiva

oxlint --print-config path/to/file.ts

Listar regras

oxlint --rules

Lista completa: referência de regras.

Próximos passos

• Regras, plugins e ignores: Configuração
• Editores
• CI
• Avançado: análise multiarquivo, lint com tipos, plugins JS
• Migração: do ESLint
• Matriz de compatibilidade
• Referência CLI