ESLintでTypeScriptベースの設定ファイル(eslint.config.ts
)を使えるようになった
2024年8月10日、TypeScriptで書かれた設定ファイルを実験的にサポートするESLint v9.9.0がリリースされました。
4月にリリースされたESLint v9.0.0では従来のeslintrc
による設定が非推奨となり、JavaScriptベースのFlat Config(eslint.config.js
)に移行しました。
今回のリリースでは、TypeScriptベースの設定ファイル(eslint.config.ts
、eslint.config.mts
、eslint.config.cts
)を実験的にサポートするようになりました。
これにより、TypeScriptによる入力補完の恩恵を受けながら、ESLintの設定ファイルを書けるようになります。
TypeScriptで設定ファイルを書く方法
TypeScriptベースの設定ファイルを利用するには、いくつかの設定が必要です。
まずは、軽量なTypeScriptのランタイム「jiti」をインストールします。jitiはESLintの依存関係に含まれていないため、手動でインストールする必要があります。
次に、従来のFlat Configのファイル(eslint.config.js
など)の拡張子を、TypeScript(eslint.config.ts
など)に変更します。記事執筆時点では、.ts
、.mts
、.cts
の拡張子がサポートされています。
必要であれば、設定ファイルに型定義を追加します。
実際にTypeScriptベースの設定ファイルを利用するには、ESLintの実行時にフラグを有効化する必要があります。
これで、TypeScriptベースの設定ファイルを利用できるようになりました。
なお、ESLintが実行時に設定ファイルの型チェックを実施しない(型定義を単にコメントとして無視する)ことと、現時点ではjitiがtop-level awaitをサポートしていないことに注意してください。
VS Codeの拡張機能で利用する方法
VS CodeのESLint拡張機能では、フラグを有効化することでTypeScriptベースの設定ファイルを利用できます。
VS Codeのsettings.json
を開き、次の設定を追加します。
設定を変更したあとは、VS Codeを再起動するかコマンドパレットから[ESLint: Restart ESLint Server
]を実行してください。