Open2022/02/22にコメント追加4

TypeScript の型情報を利用する ESLint rule の作り方を調べる

Masayuki Izumi 2022/02/22に更新

前提: （TypeScript に限らない）ESLint rule の作り方

超ざっくりで、

lib/rules/<rule-name>.js で import('eslint').Rule.RuleModule を満たすオブジェクトを export する
- 必須要素は2つ
  - meta: ドキュメントやオプションのスキーマ, レポートされうるメッセージのリスト, etc.
  - create: AST を walk して警告する実装をする関数

だけ。
test や doc に関する規定もドキュメントに書いてるけど、これは必須なのかな？

Masayuki Izumi 2022/02/22

JSConf 2021 でやってたライブコーディングでは src/index.ts で rules object を export していた

このやりかたでもいいのかな？

Masayuki Izumi 2022/02/22に更新

@typescript-eslint/eslint-plugin では

rules/<rule_name>.ts では RuleModule を default export
rules/index.ts では全 rule を集約した巨大オブジェクトを default export
- https://github.com/typescript-eslint/typescript-eslint/blob/v5.12.0/packages/eslint-plugin/src/rules/index.ts#L123-L245
index.ts で rules/index.ts で作った巨大オブジェクトを rules という名前で export

Masayuki Izumi 2022/02/22

テストには RuleTester というクラスが提供されているので、これを使う

ふつうに jest に食わせればいいのか