Skip to main content

フォーマッターについて

JavaScript / TypeScript / CSSのLintとフォーマットには Biome を採用する。

設定の正本はリポジトリ直下の biome.json である。 ドキュメントへ設定を複製せず、変更は biome.json と package.json のscriptsで行う。

本リポジトリのBiomeはv2(package.json の @biomejs/biome は ^2.0.0)である。 v1のトップレベル organizeImports や formatter.ignore は使わない。

  • インポート整列を有効にする場合は assist.actions.source.organizeImports を使う
  • 対象ファイルの絞り込みは files.includes で行い、除外は ! プレフィックスを付ける
  • 言語別の上書きは overrides と includes で行う

現行の biome.json ではformatterとlinterを有効にしている。 CSSではTailwindディレクティブの解析を許可し、Storiesなどでは noUnusedImports をオフにする。

実行コマンドは package.json の format / check / fix を正とする。

例外対応​

マークダウン​

Biome v2はMarkdownのフォーマットに対応している。 ただし本リポジトリのドキュメントはMDXと日本語校正(textlint)を含むため、.md / .mdx は Prettier で整形する。

設定の正本は .prettierrc である。 実行コマンドは package.json の format:md を正とする。 日本語の品質チェックは lint:text(textlint)で行う。