ESLint / Prettier を Biome に置き換える

[m1sk9]

現在 Pulsate, Pulsate-Web では ESLint, Prettier を使用しているが, これを Biome に置き換えたい.
Biome は CLI での Migrate に対応している.

Migrate from ESLint and Prettier | Biome

pros

• Rust を採用しており, ESLint や Prettier よりも高速 (検証はできていない. 理由は後述)
• .jsonc による設定ファイルをサポートしており, コメントが利用できる ( .json にも対応)
• Renovate にルールセットが用意されており, biome.jsonc 内の $schema を最新に保つ事ができる.
• biome ci という GitHub Action などの CI 環境での実行が想定されているサブコマンドが用意されている.

cons

• YAML や Markdown など一部言語ではサポートが行われていなかったり, 部分サポートになっている: Language support | Biome
• ESLint の移行ができない (Pulsate において)
  • Pulsate では ESLint v9 でサポートされた Flat Config を使用しているが, おそらくこれが原因? ただしドキュメントでは新しい形式でのコンフィグもサポートしているようなので不具合な可能性が否定できないが GitHub にそれらしい Issue がない.

[Allianaab2m]

ESLint の移行ができない (Pulsate において)

ESLintの外部Pluginで実現していた部分がBiome本体に含まれていることが確認できれば，migrateせずともinitして導入しても構わないと思います．

[m1sk9]

biome ci という GitHub Action などの CI 環境での実行が想定されているサブコマンドが用意されている.

この時点で相当 Biome に軍配があがる. というかルールとかを pnpm add などで別途入れる必要がないのも大きい.

pulsate/package.json

Lines 50 to 70 in 3b8fbd5

	"devDependencies": {
	"@eslint/eslintrc": "^3.0.0",
	"@eslint/js": "^9.0.0",
	"@ls-lint/ls-lint": "^2.2.3",
	"@trivago/prettier-plugin-sort-imports": "^4.3.0",
	"@types/node": "^20.11.16",
	"@typescript-eslint/eslint-plugin": "^7.0.0",
	"@typescript-eslint/parser": "^7.0.0",
	"@vitest/coverage-v8": "^2.0.0",
	"esbuild": "^0.23.0",
	"eslint": "^9.0.0",
	"eslint-config-prettier": "^9.1.0",
	"eslint-plugin-vitest": "^0.5.0",
	"glob": "^11.0.0",
	"globals": "^15.0.0",
	"ignore": "^5.3.1",
	"kleur": "^4.1.5",
	"lefthook": "^1.6.1",
	"prettier": "^3.2.5",
	"vitest": "^2.0.0"
	}

[m1sk9]

この鬱陶しい Warn を見なくて済む

[m1sk9]

@Allianaab2m , @laminne

とりあえず Biome に置き換えた作業として https://github.com/pulsate-dev/pulsate/tree/replace-eslint-and-prettier-to-biome に Push しました. そのまますんなりマージできるよう VSCode 周りの設定も変えたのでローカルに落とせば実際に使えます.

Biome の Formatter 及び Linter を走らせた状態で ./pkg や ./script は更新されていますが, その中で Biome がいくつか Lint でエラーを出しています. (前述の通り Lint のルールをそのまま Migrate はできなかったので recommend のルールをそのまま使っています)

いくつかのエラーは biome check --write で自動修正しましたが以下のエラーは修正できません.
これらのルールは受け入れるか無視するか考えたほうがいいと思ったのでリスト化しました. すり合わせをできればなと思います.

noShadowRestrictedNames

Node.js のグローバル定数で使用されている変数名を Import 文で使用することを禁止します.

mini-fn の Promise に引っかかっているようです.

noNonNullAssertion

TypeScript の non-null assertion ! を禁止します.

noUnreachableSuper

super() の複数使用を禁止する? (よくわからない)

[laminne]

noUnreachableSuperはESLintのno-this-before-superと同じらしい

[laminne]

super()を呼ぶならthisはsuper()よりもあとに書けというルールみたい

[m1sk9]

noUnreachableSuper はそのまま採用して noShadowRestrictedNames は無効かな... ( mini-fn を使ってる以上仕方ない)
noNonNullAssertion は現時点での型推論はやっぱりうまく行ってないからこれはコメントでの無効かな

[m1sk9]

noUnreachableSuper はそのまま採用して noShadowRestrictedNames は無効かな... ( mini-fn を使ってる以上仕方ない)

noNonNullAssertion は現時点での型推論はやっぱりうまく行ってないからこれはコメントでの無効かな

これで採用したいと思うけどどう？

[laminne]

とりあえずこれで良いと思います

[m1sk9]

PR を提出しました: #574