Assist

Biome Assistはコード品質と開発者体験を向上させるための一連のアクションを提供します。

リンターのルールとは異なり、アシストのアクションは常にコード修正を提供します。プロパティやフィールドのソート、二項式の単純化、リファクタリングなどを実行します。アシストのアクションはバグを検出したり、特定のコーディングスタイルを強制したりすることを目的としていません。現在 6個のアシストアクション が利用可能です。

アシストのコード修正は一般的に安全に適用できます。もしアシストの修正がコードを壊した場合、それはバグと見なされますので、バグ報告をお願いします。

アシストはエディタやIDEで最も効果を発揮します。ただし、CLIでもアシストアクションの使用を強制することが可能です。アシストアクションはセマンティクスにおいてLSPコードアクションに非常に近く、グループに分けられています。

Biomeのアシストはデフォルトで有効になっており、いくつかのルールは推奨ルールセットに含まれています。以下の例は useSortedKeys アクションを有効にする方法を示しています：

1
{
2
  "assist": {
3
    "enabled": true,
4
    "actions": {
5
      "source": {
6
        "useSortedKeys": "on"
7
      }
8
    }
9
  }
10
}

IDEでアシストアクションを使用する

LSP互換のIDEを使用している場合、保存時に特定のアクションを実行するようにBiomeを設定できます。各アシストアクションには「コードアクション」と呼ばれる特定のコードがあります。大部分の名前は同じパターンに従っていますが、いくつかの例外があります（例：organizeImports）ので、コードを知るには各アクションのドキュメントページを参照してください。

まず、保存時にすべての修正を適用するようにエディタを設定する必要があります。設定はエディタによって異なります。コードアクション名は source.fixAll.biome です：

1
{
2
  "editor.codeActionsOnSave": {
3
    "source.fixAll.biome": "explicit",
4
  }
5
}

1
{
2
  "code_actions_on_format": {
3
    "source.fixAll.biome": true,
4
  }
5
}

Use the source action code source.fixAll.biome

次に、各アクションのコードを追加できます。たとえば、アクション useSortedKeys には source.action.useSortedKeys.biome というコードアクションがあります。VS Codeを使用している場合、このコードをコピーして editor.codeActionsOnSave セクションに配置すると、ドキュメントを保存したときにBiomeがアクションを適用します：

1
{
2
  "editor.codeActionsOnSave": {
3
    "source.action.useSortedKeys.biome": "explicit",
4
    "source.fixAll.biome": "explicit"
5
  }
6
}

1
{
2
  "code_actions_on_format": {
3
    "source.action.useSortedKeys.biome": true,
4
    "source.fixAll.biome": true
5
  }
6
}

Use the source action code source.action.useSortedKeys.biome

CLIでアシストアクションを強制する

アシストアクションは check コマンドを介してCLI経由で強制できます：

1
npx @biomejs/biome check

1
pnpm exec biome check

1
bunx --bun biome check

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

1
yarn exec biome check

ただし、check は複数のツールを一度に実行するためのものなので、アシストアクションのみをチェックしたい場合は、次のように実行する必要があります：

1
npx @biomejs/biome check --formatter-enabled=false --linter-enabled=false

1
pnpm exec biome check --formatter-enabled=false --linter-enabled=false

1
bunx --bun biome check --formatter-enabled=false --linter-enabled=false

1
deno run -A npm:@biomejs/biome check --formatter-enabled=false --linter-enabled=false

1
yarn exec biome check --formatter-enabled=false --linter-enabled=false

アシストを強制しない

デフォルトでは、Biomeは check コマンドを実行するときにアシストを強制します。アシストを強制したくない場合は、--enforce-assist CLIフラグを false に使用できます。こうすることで、一部のアクションが適用されていない場合でもBiomeは診断エラーを出力しません：

1
biome check --enforce-assist=false

アシストアクションの抑制

抑制のページを参照してください。

グループ

Source

このグループは、保存時にドキュメントに安全に適用できるアクションを表します。これらのアクションは一般的にすべて安全であり、通常はプログラムの機能を変更しません。