コンテンツにスキップ
Biome
Docs Blog Playground

はじめる

インストール方法

Section titled インストール方法

Biomeをインストールする最も速い方法は、 npm またはお好みのパッケージマネージャーを使用することです。 これにはNode.js v14.18以降が必要です。

Node.jsをインストールせずにBiomeを使用したい場合は、スタンドアロン実行形式としてCLIを利用できます。

Biomeをインストールするには、 package.json ファイルが含まれるディレクトリで次のコマンドを実行します。

Terminal window
npm install --save-dev --save-exact @biomejs/biome

Biomeをインストールする際には、バージョン範囲演算子を使用しないことを強く推奨しています。詳しくは、バージョニング ページをご覧ください。

設定

Section titled 設定

プロジェクトごとに biome.json（設定ファイル）を作成することを推奨します。 これにより、コマンドを実行するたびにCLIのオプションを繰り返し指定する必要がなくなり、エディタ上で同じ設定を適用できるようになります。もしBiomeのデフォルト設定に満足している場合は、新たに設定ファイルを作成する必要はありません。

設定を作成するには、プロジェクトのルートディレクトリで init コマンドを実行します。

Terminal window
npx @biomejs/biome init

init コマンドを実行すると、そのディレクトリに biome.json ファイルが新規作成されます。

biome.json
{
  "$schema": "https://biomejs.dev/schemas/1.7.3/schema.json",
  "organizeImports": {
    "enabled": false
  },
  "linter": {
    "enabled": true,
    "rules": {
      "recommended": true
    }
  }
}

linter.enabled: true はlinterを有効にし、 rules.recommended: true は推奨ルールを有効にします。

この設定では、formatter.enabled: false で明示的にformatを無効化していないため、formatは有効になっています。

使い方

Section titled 使い方

Biome CLIには多くのコマンドとオプションが用意されているので、あなたが必要なものだけを使用できます。

format コマンドを --write オプションを指定し実行することで、ファイルやディレクトリをformatできます。

Terminal window
npx @biomejs/biome format --write <files>

lint コマンドを --apply オプションを指定し実行することで、ファイルやディレクトリに対してLintを実行し、安全な修正を適用できます。

Terminal window
npx @biomejs/biome lint --apply <files>

check コマンドを実行することで、それら両方のコマンドを実行できます。

Terminal window
npx @biomejs/biome check --apply <files>

check コマンドは複数のツールを一度に実行するためのコマンドです。現在は以下のことを行います。

  • ファイルのformat
  • ファイルのlint
  • インポートの整理

エディタプラグインのインストール

Section titled エディタプラグインのインストール

Biomeの機能を最大限活用するために、エディタプラグインをインストールすることを推奨しています。エディタのページを参照して、どのエディタがBiomeをサポートしているかを確認してください。

CIのセットアップ

Section titled CIのセットアップ

Node.jsを使用している場合、BiomeをCIで実行するには、お気に入りのパッケージマネージャを使用することが推奨されます。 このようにすることで、CIパイプラインがエディタ上やローカルでCLIコマンドを実行するときと同じバージョンのBiomeを使用することを保証できます。

次のステップ

Section titled 次のステップ

成功です！これでBiomeを使う準備が整いました。🥳