コマンドラインインターフェース

使用方法

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

基本設定

• -c, --config=<./.oxlintrc.json> — Oxlint の設定ファイル

• .json 形式の設定ファイルは、すべての実行環境でサポートされています

• JavaScript/TypeScript 形式の設定ファイルは実験的であり、Node.js を経由して実行する必要があります

• 設定ファイル内にコメントを使用できます

• ESLint v8 の形式と互換性をできるだけ維持しています

  指定されない場合、Oxlint は現在の作業ディレクトリで .oxlintrc.json を探します。

• --tsconfig=<./tsconfig.json> — TypeScript tsconfig.json ファイルのパス。インポートプラグイン用にパスエイリアスやプロジェクト参照を読み取るためです。指定されない場合、現在の作業ディレクトリで tsconfig.json を探します。
• --init — 既定値で Oxlint 設定を初期化します

複数の lint を許可／拒否する

コマンドライン上で左から右へ向かってルールおよびカテゴリを積み重ねます。

たとえば -D correctness -A no-debugger または -A all -D no-debugger のように使用します。カテゴリは以下の通りです：

• correctness - 明らかに誤っているか無意味なコード（デフォルト）
• suspicious - 多くの場合誤っているか無意味なコード
• pedantic - かなり厳格であるか、時折誤検出がある可能性のある lint
• perf - よりパフォーマンスが良い書き方で書けるコード
• style - より自然な記法で書けるべきコード
• restriction - 言語やライブラリ機能の使用を制限する lint
• nursery - 開発途中の新しい lint
• all - 以上すべてのカテゴリ（nursery を除く）。プラグインは自動的に有効化されません。

引数：

• -A, --allow=NAME — ルールまたはカテゴリを許可（lint を抑制）
• -W, --warn=NAME — ルールまたはカテゴリを拒否（警告を出力）
• -D, --deny=NAME — ルールまたはカテゴリを拒否（エラーを出力）

プラグインの有効／無効化

• --disable-unicorn-plugin — デフォルトで有効になっているユニコーンプラグインを無効化
• --disable-oxc-plugin — デフォルトで有効になっている oxc 特有のルールを無効化
• --disable-typescript-plugin — デフォルトで有効になっている TypeScript プラグインを無効化
• --import-plugin — インポートプラグインを有効化し、ESM の問題を検出します。プロジェクトに tsconfig.json 以外の名前の tsconfig がある場合は、--tsconfig オプションと共に使用する必要があります。
• --react-plugin — React プラグインを有効化（デフォルトでは無効）
• --jsdoc-plugin — JSDoc プラグインを有効化し、JSDoc の問題を検出
• --jest-plugin — Jest プラグインを有効化し、テストの問題を検出
• --vitest-plugin — Vitest プラグインを有効化し、テストの問題を検出
• --jsx-a11y-plugin — JSX-a11y プラグインを有効化し、アクセシビリティの問題を検出
• --nextjs-plugin — Next.js プラグインを有効化し、Next.js 専用の問題を検出
• --react-perf-plugin — React パフォーマンスプラグインを有効化し、レンダリングパフォーマンスの問題を検出
• --promise-plugin — Promise プラグインを有効化し、Promise に関する使用上の問題を検出
• --node-plugin — Node プラグインを有効化し、Node.js に関する使用上の問題を検出
• --vue-plugin — Vue プラグインを有効化し、Vue に関する使用上の問題を検出

問題の修正

• --fix — 可能な限り多くの問題を修正します。出力には未修正の問題のみが表示されます。
• --fix-suggestions — オートフィックス可能な提案を適用します。プログラムの動作を変更する可能性があります。
• --fix-dangerously — 危険な修正および提案を適用します

ファイルの無視

• --ignore-path=PATH — .eslintignore として使用するファイルを指定

• --ignore-pattern=PAT — 無視するファイルのパターンを指定（.eslintignore に加えて）

  対応している構文は .eslintignore および .gitignore ファイルと同じです。シェルによるグロブパターンの解釈を避けるために、パターンは引用符で囲む必要があります。

• --no-ignore — .eslintignore ファイル、--ignore-path フラグ、--ignore-pattern フラグによるファイル除外を無効化

警告の扱い

• --quiet — 警告の報告を無効化。エラーのみが報告される
• --deny-warnings — 警告がゼロ以外の終了コードを出力することを保証
• --max-warnings=INT — 警告のしきい値を指定。プロジェクト内の警告レベルのルール違反が多すぎると、エラー状態で終了させるために使用できます

出力

• -f, --format=ARG — 特定の出力形式を使用。可能な値：checkstyle, default, github, gitlab, json, junit, stylish, unix

その他

• --silent — ダイアグノスティックを一切表示しない
• --threads=INT — 利用するスレッド数。1 に設定すると、1 つの CPU コアのみを使用します。
• --print-config — ここで使用される設定を出力します。このオプションが存在する場合、lint は実行されず、設定関連のオプションのみが有効になります。

インライン設定コメント

• --report-unused-disable-directives — その行にそもそもエラーが報告されないのに、// oxlint-disable-line のようなディレクティブコメントが使われている場合を報告
• --report-unused-disable-directives-severity=SEVERITY — --report-unused-disable-directives と同じですが、報告されるエラーの深刻度レベルを指定できます。この2つのオプションは同時に1つしか使用できません。

利用可能な位置引数：

• PATH — 単一ファイル、単一パス、またはパスのリスト

利用可能なオプション：

• --rules — 現在登録されているすべてのルールを一覧表示
• --lsp — 言語サーバーを起動
• --disable-nested-config — ネストされた設定ファイルの自動読み込みを無効化
• --type-aware — 型情報が必要なルールを有効化
• --type-check — 実験的な型チェックを有効化（TypeScript コンパイラの診断情報を含む）
• -h, --help — ヘルプ情報を出力
• -V, --version — バージョン情報を出力