Skip to content

feat: document ignore all formatter #3797

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ematipico merged 1 commit into from
Jan 6, 2026
Merged

feat: document ignore all formatter #3797

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 33 additions & 5 deletions src/content/docs/formatter/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,10 +94,41 @@ See the [configuration reference](/reference/configuration#formatter) for more d

There are times when the formatted code isn't ideal.

For these cases, you can use a format suppression comment:
### Ignore an entire file

You can suppress (ignore) the formatter for an entire file by using the `biome-ignore-all format: reason` comment **at the top of the file**:

For example, in JavaScript:

```js title="example.js"
// biome-ignore format: <explanation>
// biome-ignore-all format: generated file

const expr1 =
[
(2 * n) / (r - l),
0,
(r + l) / (r - l),
-1,
0,
];


const expr2 =
[
(2 * n) / (r - l),
0,
(r + l) / (r - l),
-1,
0,
];
```

### Ignore nodes

In case you want to suppress only a portion (node) of the code, use the suppression comment `biome-ignore format: reason`

```js title="example.js"
// biome-ignore format: reason
```

Example:
Expand All @@ -124,6 +155,3 @@ const expr =
0,
];
```

Biome doesn't provide ignore comments that ignore an entire file.
However, you can [ignore a file using the Biome configuration file](/guides/configure-biome/#ignore-files).