コンテンツにスキップ

エディタ拡張機能へのBiomeの統合

Biomeは LSP を一流のサポートとして提供しています。エディタがLSPを実装している場合、Biomeの統合はシームレスに行われるはずです。

Biomeには lsp-proxy というコマンドがあります。このコマンドを実行すると、Biomeは以下の2つのプロセスを生成します:

  • 要求された操作を実行するデーモン
  • クライアント(エディタ)からのリクエストとサーバー(デーモン)間のプロキシとして機能するサーバー

エディタがサーバーとやり取りし、JSON-RPC リクエストを送信できる場合、このコマンドを実行するようにエディタを設定するだけで済みます。

neo-vim biome extension がどのように実装しているかを確認できます。

エディタがLSPをサポートしていない場合でも、バイナリ biome を直接使用し、標準入力を介して呼び出すことができます。

以下のコマンドは標準入力を介して呼び出すことができます:

Biomeは新しい出力(変更がない場合は元の出力)を標準出力に、診断結果を標準エラーに返します。

stdin を使用する場合、--stdin-file-path オプションを渡す必要があります。このファイルパスはファイルシステム上に存在する必要はありません。任意の名前で構いませんが、重要なのは正しいファイル拡張子を指定することです。これにより、Biomeはファイルの処理方法を認識します。

エディタがバイナリのパスを解決し、必要に応じて呼び出す責任を負います。サポートしているアーキテクチャとOSに基づいて、バイナリはnpmに配布されています:

  • @biomejs/cli-darwin-arm64
  • @biomejs/cli-darwin-x64
  • @biomejs/cli-linux-arm64
  • @biomejs/cli-linux-x64
  • @biomejs/cli-win32-arm64
  • @biomejs/cli-win32-x64

バイナリ名は biome または biome.exe で、ライブラリのルートディレクトリに配置されています。例:@biomejs/cli-darwin-arm64/biome@biomejs/cli-win32-x64/biome.exe

Biomeの言語サーバは以下の設定を公開しており、拡張機能はこれらをユーザーに公開できます。

型: boolean デフォルト: false

Biomeの言語サーバが設定ファイルを必要とするかどうか。trueに設定すると、プロジェクトのルートにbiome.jsonファイルがあるまで、(パース以外の)ファイルの解析を行いません。

{
"require_configuration": true
}

型: string デフォルト: null

カスタム設定ファイルへのパス。パスは biome.json / biome.jsonc があるフォルダ、またはファイルへのパスを指定できます。

パスは相対パスまたは絶対パスで指定できます。Biomeの言語サーバは、この設定が指定された場合にのみ読み取ります。設定が プロジェクトのサブフォルダにある 場合にこの設定を使用してください。

{
"configuration_path": "./frontend/biome.json"
}

型: object デフォルト: null

Biome設定のインラインバージョン。この設定のオプションは、ディスクから読み取られた biome.json ファイル(またはデフォルト値)のオプションを上書きします。

例えば、プロジェクトで noConsole ルールを error の重大度で有効にしているとします:

biome.json
{
"linter": {
"rules": {
"suspicious": {
"noConsole": "error"
}
}
}
}

しかし、ローカル開発中は、このルールが便利で赤い波線を見たくないため、このルールを無効にしたいとします。inline_configには、次のように記述します:

{
"inline_config": {
"linter": {
"rules": {
"suspicious": {
"noConsole": "off"
}
}
}
}
}

バイナリとデーモンを使用する

Section titled “バイナリとデーモンを使用する”

CLIを介してバイナリを使用するのは非常に効率的ですが、ログをユーザーに提供することはできません。CLIを使用するとデーモンを起動し、デーモン経由でCLIコマンドを使用できます。

これを行うには、まず start コマンドでデーモンプロセスを開始する必要があります:

Terminal window
biome start

その後、すべてのコマンドに --use-server オプションを追加する必要があります。例:

Terminal window
echo "console.log('')" | biome format --use-server --stdin-file-path=dummy.js

Biomeデーモンはログをファイルシステムに保存します。ログは biome-logs というフォルダに保存されます。このフォルダのパスはOSによって異なります:

  • Linux: ~/.cache/biome
  • Windows: C:\Users\<UserName>\AppData\Local\biomejs\biome\cache
  • macOS: /Users/<UserName>/Library/Caches/dev.biomejs.biome

その他のOSでは、システムの一時ディレクトリ内にフォルダがあります。

正確なパスを取得するには、以下のコマンドを実行してください:

Terminal window
biome explain daemon-logs

ログファイルは毎時ローテーションされます。