クイックスタート

このページでは、Oxlint に推奨される設定およびコピー＆ペースト可能なコマンドを使用した最も一般的なワークフローを示します。

インストール

oxlint を開発依存関係としてインストールします：

npm

$ npm add -D oxlint

pnpm

$ pnpm add -D oxlint

yarn

$ yarn add -D oxlint

bun

$ bun add -D oxlint

package.json にリントコマンドを追加します：

package.json

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

実行します：

npm

npm run lint

pnpm

pnpm run lint

yarn

yarn run lint

bun

bun run lint

修正を適用します：

npm

npm run lint:fix

pnpm

pnpm run lint:fix

yarn

yarn run lint:fix

bun

bun run lint:fix

使い方

オプションの完全リストについては、CLI リファレンス を参照してください。

oxlint [OPTIONS] [PATH]...

PATH が省略された場合、Oxlint は現在の作業ディレクトリを対象にリント処理を行います。

一般的なワークフロー

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"
  }
}

設定ファイルの作成

デフォルト値で .oxlintrc.json の設定ファイルを初期化します：

oxlint --init

その後、必要に応じて .oxlintrc.json をカスタマイズしてください。詳細は 設定 を参照してください。

あるいは、oxlint.config.ts という名前の TypeScript 設定ファイルもサポートされています。詳しくは 設定 を参照してください。

その後、Oxlint を実行します：

oxlint

TIP

ESLint から移行している場合、「ESLint からの移行」ページ を参照して、詳細な移行ガイドをご覧ください。

問題の修正

安全な修正を適用します：

oxlint --fix

提案内容を適用（プログラムの振る舞いを変更する可能性あり）：

oxlint --fix-suggestions

危険な修正および提案を適用：

oxlint --fix-dangerously

各モードの使用タイミングについては、自動修正 を参照してください。

ファイルの無視

明示的な無視ファイルを使用します：

oxlint --ignore-path .oxlintignore

コマンドラインから無視パターンを追加します：

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

無視処理を無効にします：

oxlint --no-ignore

詳細は 無視ファイル を参照してください。

CI の信頼性確保

エラーのみを報告：

oxlint --quiet

警告が1つでも検出されたら失敗：

oxlint --deny-warnings

警告の数がしきい値を超えた場合に失敗：

oxlint --max-warnings 0

詳細は CI 設定 を参照してください。

マシン読み取り可能な出力の利用

出力形式を選択します：

oxlint -f json

利用可能な形式には：default、json、unix、checkstyle、github、gitlab、junit、stylish があります。

実効設定の確認

ファイルに対して使われる設定を出力します：

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

利用可能なルールの一覧表示

登録済みのルール（現在の oxlint 設定で有効になっているものも含む）を一覧表示します：

oxlint --rules

完全なリストは ルールリファレンス にあります。

次のステップ

• ルール、プラグイン、無視の設定：設定
• エディタのセットアップ
• CI のセットアップ
• 高度な機能の学習：マルチファイル分析、型情報対応のリント、JS プラグイン
• 移行：ESLint からの移行
• CLI リファレンス