コンテンツにスキップ

Biome をあなたのエディタに導入する

これらは、Biome チームや Biome organization によってメンテナンスされているプラグインです。

Biome のプラグインを使うと、以下のことができます:

  • ファイルの保存時やコマンドを実行したときに、formatを実行する
  • ファイルの静的解析をし、コードの修正を適用する

Visual Studio Code マーケットプレイスページで、Biome VS Code extension をインストールしてください。

Biome をデフォルトのformatterにするには、サポート対象の言語に関するファイル を開いて、以下の手順に従ってください:

  • コマンドパレットを開く(Ctrl/++P または表示 → コマンドパレット)
  • ドキュメントのformat… を選択
  • デフォルトのformatterの設定… を選択
  • Biomeを選択

Biome IntelliJ 向けのプラグインをインストールするには、プラグインの公式ページ にアクセスするか、以下の手順に従ってください:

JetBrains IDEs の場合:

  1. IntelliJ IDEA を開く。
  2. Settings/Preferences に移動する。
  3. 左のメニューから Plugins を選択する。
  4. Marketplace タブをクリックする。
  5. 検索ボックスに “Biome” と入力し、Install をクリックする。
  6. IDEを再起動して、プラグインを有効にする。

ディスクからの場合:

  1. releases タブからプラグインの .zip をダウンロードする。
  2. ⌘Сmd, を押して IDE の設定を開き、Plugins を選択する。
  3. プラグインページで Settings ボタンをクリックし、Install Plugin from Disk… をクリックする。

サードパーティのプラグイン

Section titled サードパーティのプラグイン

これらは、各種エディタで使用できる、コミュニティによってメンテナンスされているプラグインです:

プラグインを実装する

Section titled プラグインを実装する

Biome は LSP を優先的にサポートしています。 エディタが LSP を実装している場合、Biome の導入はスムーズであるべきです。

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

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

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

neo-vim biome プラグイン がどのようにその処理を行っているか確認してみてください。

エディタが LSP をサポートしていない場合は、 標準入力 を利用して biome バイナリを直接操作します。

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

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

stdin を使用する場合は、 --stdin-file-path オプションを渡す必要があります。 オプションに渡すファイルの 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

バイナリを使ったデーモン

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の一時ディレクトリに作成されています。

Windows の場合は、powershell で以下のコマンドを実行すると、一時ディレクトリの場所を確認できます:

Terminal window
$env:TEMP

Linux/macOS の場合は、ターミナルで以下のコマンドを実行して確認ができます:

Terminal window
echo $TMPDIR

ログファイルは、1時間ごとにローテーションされます。