oxc-project/migrate-oxlint

migrate-oxlint は何をしますか？

ESLint から Oxlint へのプロジェクト移行ガイド。JavaScript/TypeScript プロジェクトのリンターを ESLint から Oxlint に移行、変換、または切り替える際に使用します。

概要

Oxlint は oxc プロジェクトの一部として開発された高速な Rust 製リンターです。ESLint の多くのルールをサポートし、パフォーマンスが大幅に向上します。このガイドでは、既存の ESLint 設定から Oxlint への移行手順を説明します。

主な利点

• 高速: Rust で書かれており、ESLint よりもはるかに高速に動作します。
• 互換性: ESLint のルールの多くをサポートしており、移行がスムーズです。
• シンプル: 設定が簡単で、デフォルトで多くのベストプラクティスを提供します。

移行手順

1. Oxlint のインストール

   npm install -D oxlint
   # または
   yarn add -D oxlint
   # または
   pnpm add -D oxlint
   

2. ESLint 設定の確認

   現在の ESLint 設定ファイル（.eslintrc.* や eslint.config.*）を確認し、使用しているルールを把握します。

3. ルールの互換性チェック

   Oxlint がサポートするルールは、公式ドキュメント を確認してください。多くの一般的なルールはサポートされていますが、一部のプラグイン固有のルールは移行できない場合があります。

4. 設定ファイルの作成

   Oxlint は設定ファイルとして oxlintrc.json または oxlintrc.yaml を使用します。次は例です：

   {
     "rules": {
       "no-unused-vars": "error",
       "no-console": "warn"
     }
   }
   

5. スクリプトの更新

   package.json の lint スクリプトを更新します：

   {
     "scripts": {
       "lint": "oxlint"
     }
   }
   

6. 移行の確認

   以下のコマンドを実行して、Oxlint が正しく動作するか確認します：

   npx oxlint
   

注意点

• ESLint のすべてのプラグインが Oxlint で利用できるわけではありません。移行前に互換性を確認してください。
• Oxlint はデフォルトで多くのルールを有効にしているため、初期の実行で多くの警告が表示される可能性があります。必要に応じてルールを無効化または調整してください。
• 移行後も ESLint を併用することは可能ですが、できるだけ早く完全に移行することを推奨します。

参考資料

• Oxlint 公式ドキュメント
• oxc プロジェクト GitHub
• ESLint からの移行ガイド（英語）