Biome の Visual Studio Code 拡張機能 を入れた際にグローバル(風)な設定ファイルを適用する方法

状況

  • 「プロジェクト」に Biome(バイオーム)が導入されていない
  • 「プロジェクト」に Biome は入れたくない(入れられない)
  • Biome 自体は使いたい
  • Biome の設定ファイルは拡張機能にビルトインされたものではなく、自分で書いたものを使いたい
    • ビルトインの設定だと editor.insertSpaces: false であり、「タブ」でインデントされてしまうのが個人的に好まない

結論

1. グローバルに Biome を入れる

$ npm install -g @biomejs/biome

2. プロジェクトルートに設定ファイルを作成する

  • biome.jsonc の方がコメントが書けて便利だが、Biome は現時点では JSONC に対応していない
    • このような事例では Prettier を使うのが現状ではベターか
    • 将来的には対応すると思う
{
  "$schema": "https://biomejs.dev/schemas/1.9.4/schema.json",
  // 省略
}

3. 設定ファイルをコミットしてしまわないように .git/info/exclude に追記しておく

  • コミットしてもいい場合はこのステップは不要
  • コミットしたくない場合には .git/info/exclude に設定ファイル名を記載しておく
    • もし将来的に正式に導入する場合には、この記載を削除することを忘れないこと*1

4. もし「2.」と「3.」の作業が面倒ならば自動化を考える

  • そこまでやる必要はないと思うけれど、他の作業も含め、プロジェクトに対して定型作業が一定以上発生するようなら自動化してもいい
    • dotfiles に入っていると管理しやすいかも

補足

  • CLI 単体の動作では BIOME_CONFIG_PATH という環境変数で設定ファイルを指定することで、いろいろと頑張れる可能性がある
    • direnv などと組み合わせるとよさそう
    • Visual Studio Code の拡張機能の場合はこれを使ってはいけない
  • おそらく将来的には拡張機能に様々な設定が組み込まれ、もろもろ解決すると思われる
    • したがって、上記のやり方をあまり突き詰める必要はない*2と思われる

*1:設定ファイルが永遠にコミットされないままになるから

*2:ワークアラウンドで十分

Powered by はてなブログ