Linha de comando

Uso

oxlint [-c=<./.oxlintrc.json>] [PATH]...

Configuração básica

• -c, --config=<./.oxlintrc.json> — Arquivo de configuração Oxlint

• .json e .jsonc em todos os runtimes

• Config em JavaScript/TypeScript é experimental e exige Node.js

• comentários são permitidos nos arquivos de configuração

• busca compatibilidade com ESLint v8

  Se omitido, o Oxlint procura .oxlintrc.json, .oxlintrc.jsonc ou oxlint.config.ts no diretório de trabalho atual.

• --tsconfig=<./tsconfig.json> — Substitui o tsconfig usado na resolução de imports. O Oxlint já descobre o tsconfig.json pertinente por arquivo. Use só com nome ou caminho não padrão.

  Evite usar esta opção. Pode divergir da resolução de imports e do lint orientado a tipos. O modo com tipos não usa esta flag e sempre encontra o tsconfig.json adequado. :::

• --init — Criar config Oxlint com valores padrão

Permitir / negar vários lints

Regras e categorias acumulam-se da esquerda para a direita na CLI.

Por exemplo -D correctness -A no-debugger ou -A all -D no-debugger. Categorias:

• correctness — código claramente errado ou inútil (padrão)
• suspicious — código que provavelmente está errado ou é inútil
• pedantic — regras bem estritas, às vezes com falsos positivos
• perf — código que poderia ser mais performático
• style — estilo mais idiomático
• restriction — evita uso de certos recursos de linguagem e biblioteca
• nursery — novas regras ainda em desenvolvimento
• all — todas as acima, exceto nursery; não habilita plugins automaticamente.

Flags:

• -A, --allow=NAME — Permite regra ou categoria (suprime o lint)
• -W, --warn=NAME — Trata como aviso
• -D, --deny=NAME — Trata como erro

Plugins

• --disable-unicorn-plugin — Desativa plugin unicorn (ligado por padrão)
• --disable-oxc-plugin — Desativa regras próprias oxc (ligado por padrão)
• --disable-typescript-plugin — Desativa plugin TypeScript (ligado por padrão)
• --import-plugin — Liga plugin import e diagnósticos ESM
• --react-plugin — Liga plugin react (desligado por padrão)
• --jsdoc-plugin — Liga plugin jsdoc / JSDoc
• --jest-plugin — Liga plugin Jest
• --vitest-plugin — Liga plugin Vitest
• --jsx-a11y-plugin — Liga JSX-a11y / acessibilidade
• --nextjs-plugin — Liga plugin Next.js
• --react-perf-plugin — Liga plugin de performance React
• --promise-plugin — Liga plugin promise
• --node-plugin — Liga plugin node
• --vue-plugin — Liga plugin vue

Correções

• --fix — Corrige o máximo possível; relatório só com o que sobrar
• --fix-suggestions — Aplica sugestões auto-fixáveis; pode mudar comportamento
• --fix-dangerously — Aplica correções e sugestões marcadas como perigosas

Ignorar arquivos

• --ignore-path=PATH — Arquivo usado como .eslintignore

• --ignore-pattern=PAT — Padrões extras (além dos de .eslintignore)

  Sintaxe igual a .eslintignore / .gitignore; coloque globs entre aspas para não expandir no shell.

• --no-ignore — Ignora .eslintignore, --ignore-path e --ignore-pattern

Tratamento de warnings

• --quiet — Não relatórios de aviso, só erro
• --deny-warnings — Código de saída diferente de zero se houver avisos
• --max-warnings=INT — Limite de avisos; acima disto termina em erro

Saída

• -f, --format=ARG — Formato: checkstyle, default, github, gitlab, json, junit, stylish, unix

Diversos

• --silent — Não imprime diagnósticos
• --no-error-on-unmatched-pattern — Sem erro quando nenhum arquivo for selecionado após ignores
• --threads=INT — Número de threads; use 1 para um núcleo
• --print-config — Imprime a config aplicável sem rodar lint; só opções relacionadas à config fazem sentido

Diretivas em linha

• --report-unused-disable-directives — Reporta // oxlint-disable-line etc. quando a linha não teria problema de todo modo
• --report-unused-disable-directives-severity=SEVERITY — Igual ao anterior com severidade explícita; não usar junto da opção acima.

Posicionais

• PATH — Um arquivo, diretório ou lista de caminhos

Opções

• --rules — Lista regras registradas
• --lsp — Inicia o language server
• --disable-nested-config — Não carregar configs aninhadas automaticamente
• --type-aware — Ativa regras que precisam de informações de tipo
• --type-check — Type-check experimental (diagnósticos do compilador TypeScript)
• -h, --help — Ajuda
• -V, --version — Versão