| title | description |
|---|---|
はじめる |
Biomeと共に新しいプロジェクトを立ち上げる方法を学びます。 |
import PackageManagerBiomeCommand from "@src/components/PackageManagerBiomeCommand.astro"; import PackageManagerCommand from "@src/components/PackageManagerCommand.astro";
- Windows（WSLを含む）、macOS、またはLinux
- x86_64またはARM64
- Node.js v14.18以上（スタンドアロン実行形式を使用する場合は不要）
Biomeをインストールする最も速い方法は、 npm またはお好みのパッケージマネージャーを使用することです。Node.jsをインストールせずにBiomeを使用したい場合は、スタンドアロン実行形式としてCLIを利用できます。
Biomeをインストールするには、 package.json ファイルが含まれるディレクトリで次のコマンドを実行します。
:::note[注] Biomeをローカルではなくグローバルにインストールすることも可能ですが、推奨されていません。 :::
Biomeをインストールする際には、バージョン範囲演算子を使用しないことを強く推奨しています。詳しくは、バージョニング ページをご覧ください。
プロジェクトごとに biome.json（設定ファイル）を作成することを推奨します。
これにより、コマンドを実行するたびにCLIのオプションを繰り返し指定する必要がなくなり、エディタ上で同じ設定を適用できるようになります。もしBiomeのデフォルト設定に満足している場合は、新たに設定ファイルを作成する必要はありません。
設定を作成するには、プロジェクトのルートディレクトリで init コマンドを実行します。
init コマンドを実行すると、そのディレクトリに biome.json ファイルが新規作成されます。
{
"$schema": "https://biomejs.dev/schemas/1.4.0/schema.json",
"organizeImports": {
"enabled": false
},
"linter": {
"enabled": true,
"rules": {
"recommended": true
}
}
}linter.enabled: true はLinterを有効にし、 rules.recommended: true は推奨ルールを有効にします。
この設定では、formatter.enabled: false で明示的にフォーマットを無効化していないため、フォーマットは有効になっています。
Biome CLIには多くのコマンドとオプションが用意されているので、あなたが必要なものだけを使用できます。
format コマンドを --write オプションを指定し実行することで、ファイルやディレクトリをフォーマットできます。
lint コマンドを --apply オプションを指定し実行することで、ファイルやディレクトリに対してLintを実行し、安全な修正を適用できます。
check コマンドを実行することで、それら両方のコマンドを実行できます。
check コマンドは複数のツールを一度に実行するためのコマンドです。現在は以下のことを行います。
- ファイルのフォーマット
- ファイルのLint
- インポートの整理
Biomeの機能を最大限活用するために、エディタプラグインをインストールすることを推奨しています。エディタのページを参照して、どのエディタがBiomeをサポートしているかを確認してください。
Node.jsを使用している場合、BiomeをCIで実行するには、お気に入りのパッケージマネージャを使用することが推奨されます。 このようにすることで、CIパイプラインがエディタ上やローカルでCLIコマンドを実行するときと同じバージョンのBiomeを使用することを保証できます。
成功です！これでBiomeを使う準備が整いました。🥳
- Formatterの使い方と設定方法について詳しく知る
- Linterの使い方と設定方法について詳しく知る
- CLIオプションを使いこなす
- 設定オプションを使いこなす
- Discordのコミュニティに参加する