はじめる

Biomeはプロジェクトの開発依存としてインストールするのが最適ですが、Node.jsを必要としないスタンドアロン実行形式としても利用可能です。

1
npm i -D -E @biomejs/biome

1
pnpm add -D -E @biomejs/biome

1
bun add -D -E @biomejs/biome

1
deno add -D npm:@biomejs/biome

1
yarn add -D -E @biomejs/biome

設定

Biomeは設定なしでも動作しますが、プロジェクトのニーズに合わせていくつかの設定を調整したい場合は、次のコマンドを実行して biome.json 設定ファイルを生成できます。

1
npx @biomejs/biome init

1
pnpx @biomejs/biome init

1
bunx --bun @biomejs/biome init

1
deno run -A npm:@biomejs/biome init

1
yarn exec biome init

使い方

プロジェクトでBiomeを使用する方法の概要を説明します。

コマンドラインインターフェース

Biomeは、コードのフォーマット、リント、チェックを行うためのコマンドラインインターフェースを提供します。

1
# すべてのファイルをフォーマット
2
npx @biomejs/biome format --write
3

4
# 特定のファイルをフォーマット
5
npx @biomejs/biome format --write <files>
6

7
# すべてのファイルをリントし、安全な修正を適用
8
npx @biomejs/biome lint --write
9

10
# 特定のファイルをリントし、安全な修正を適用
11
npx @biomejs/biome lint --write <files>
12

13
# すべてのファイルをフォーマット、リント、インポート整理
14
npx @biomejs/biome check --write
15

16
# 特定のファイルをフォーマット、リント、インポート整理
17
npx @biomejs/biome check --write <files>

1
# すべてのファイルをフォーマット
2
pnpm exec biome format --write
3

4
# 特定のファイルをフォーマット
5
pnpm exec biome format --write <files>
6

7
# すべてのファイルをリントし、安全な修正を適用
8
pnpm exec biome lint --write
9

10
# 特定のファイルをリントし、安全な修正を適用
11
pnpm exec biome lint --write <files>
12

13
# すべてのファイルをフォーマット、リント、インポート整理
14
pnpm exec biome check --write
15

16
# 特定のファイルをフォーマット、リント、インポート整理
17
pnpm exec biome check --write <files>

1
# すべてのファイルをフォーマット
2
bunx biome format --write
3

4
# 特定のファイルをフォーマット
5
bunx biome format --write <files>
6

7
# すべてのファイルをリントし、安全な修正を適用
8
bunx biome lint --write
9

10
# 特定のファイルをリントし、安全な修正を適用
11
bunx biome lint --write <files>
12

13
# すべてのファイルをフォーマット、リント、インポート整理
14
bunx biome check --write
15

16
# 特定のファイルをフォーマット、リント、インポート整理
17
bunx biome check --write <files>

1
# 特定のファイルをフォーマット
2
deno run -A npm:@biomejs/biome format --write <files>
3

4
# すべてのファイルをフォーマット
5
deno run -A npm:@biomejs/biome format --write
6

7
# すべてのファイルをリントし、安全な修正を適用
8
deno run -A npm:@biomejs/biome lint --write
9

10
# 特定のファイルをリントし、安全な修正を適用
11
deno run -A npm:@biomejs/biome lint --write <files>
12

13
# すべてのファイルをフォーマット、リント、インポート整理
14
deno run -A npm:@biomejs/biome check --write
15

16
# 特定のファイルをフォーマット、リント、インポート整理
17
deno run -A npm:@biomejs/biome check --write <files>

1
# すべてのファイルをフォーマット
2
yarn exec biome format --write
3

4
# 特定のファイルをフォーマット
5
yarn exec biome format --write <files>
6

7
# すべてのファイルをリントし、安全な修正を適用
8
yarn exec biome lint --write
9

10
# 特定のファイルをリントし、安全な修正を適用
11
yarn exec biome lint --write <files>
12

13
# すべてのファイルをフォーマット、リント、インポート整理
14
yarn exec biome check --write
15

16
# 特定のファイルをフォーマット、リント、インポート整理
17
yarn exec biome check --write <files>

エディタ統合

Biomeはお気に入りのエディタでファーストパーティの拡張機能として利用可能です。

Vim、Neovim、Sublime Textなどの他のエディタ向けのコミュニティ拡張機能もあります。

継続的インテグレーション

チーム全体でコード品質と一貫性を保つために、CIパイプラインの一部として biome ci を実行します。これは biome check コマンドと同様に動作しますが、CI環境向けに最適化されています。

その他の例については、継続的インテグレーションのレシピをご覧ください。

次のステップ

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

ESLintとPrettierから移行する
Biomeの設定方法について詳しく知る
フォーマッタの使い方と設定方法について詳しく知る
リンタの使い方と設定方法について詳しく知る
CLIコマンドとオプションを使いこなす
設定オプションを使いこなす
Discordのコミュニティに参加する