Assist

Este conteúdo não está disponível em sua língua ainda.

Biome Assist offers a series of actions meant to improve code quality and developer experience.

Contrary to linter rules, assist actions always offer a code fix. They might sort properties or fields, simplify binary expressions, perform refactorings, and more. Assist actions are not meant to catch bugs or impose a particular coding style. There are currently 4 assist actions available.

Assist code fixes are generally safe to apply. If an assist fix breaks your code, we would consider this a bug and appreciate bug reports.

Assist works best in editors and IDEs. However, it’s possible to enforce the use of assist actions even with the CLI. Assist actions are very close to LSP code actions in semantics, and they are divided in groups.

Biome assist is enabled by default, and some rules are in the recommended rule set. The following example shows how to enable the useSortedKeys action:

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

Use assist actions in your IDE

If you have an LSP-compatible IDE, then you can configure Biome to execute particular actions on save. Each assist action has a particular code called “code action”. While the majority of names follow the same pattern, there might be few exceptions (e.g. organizeImports), so refer to the documentation page of each action to learn to associated code.

First, you need to setup your editor for apply all fixes on save. The configuration changes based on your editor. The code action name is 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

Then, you can add the code of each action. For example, the action useSortedKeys has a code action called source.action.useSortedKeys.biome. If you use VSCode, you can copy this code and place it in the editor.codeActionsOnSave section, and Biome will apply it when you save a document:

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

Enforce assist actions via CLI

Assist actions can be enforced via CLI via check command:

1
npx @biomejs/biome check

1
yarn exec biome check

1
pnpm exec biome check

1
bunx --bun biome check

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

However, the check is meant for running multiple tools at once, so if you want to check only the assist actions, you should run:

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

1
yarn exec 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

Suppression assist actions

You can refer to the suppression page.

Groups

Source

This group represents those actions that can be safely applied to a document upon saving. These actions are all generally safe, they typically don’t change the functionality of the program.