Getting Started

Это содержимое пока не доступно на вашем языке.

Biome is best installed as a development dependency of your projects, but it is also available as a standalone executable that doesn’t require 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

Configuration

Although Biome can run with zero configuration, you’ll likely want to tweak some settings to suit your project’s needs, in which case you can run the following command to generate a biome.json configuration file.

1
npx @biomejs/biome init

1
pnpm exec biome init

1
bunx --bun biome init

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

1
yarn exec biome init

Usage

Lets get a quick overview of how to use Biome in your project.

Command-line interface

Biome provides a command-line interface to format, lint, and check your code.

1
# Format all files
2
npx @biomejs/biome format --write
3

4
# Format specific files
5
npx @biomejs/biome format --write <files>
6

7
# Lint files and apply safe fixes to all files
8
npx @biomejs/biome lint --write
9

10
# Lint files and apply safe fixes to specific files
11
npx @biomejs/biome lint --write <files>
12

13
# Format, lint, and organize imports of all files
14
npx @biomejs/biome check --write
15

16
# Format, lint, and organize imports of specific files
17
npx @biomejs/biome check --write <files>

1
# Format all files
2
pnpm exec biome format --write
3

4
# Format specific files
5
pnpm exec biome format --write <files>
6

7
# Lint and apply safe fixes to all files
8
pnpm exec biome lint --write
9

10
# Lint files and apply safe fixes to specific files
11
pnpm exec biome lint --write <files>
12

13
# Format, lint, and organize imports of all files
14
pnpm exec biome check --write
15

16
# Format, lint, and organize imports of specific files
17
pnpm exec biome check --write <files>

1
# Format all files
2
bunx biome format --write
3

4
# Format specific files
5
bunx biome format --write <files>
6

7
# Lint and apply safe fixes to all files
8
bunx biome lint --write
9

10
# Lint files and apply safe fixes to specific files
11
bunx biome lint --write <files>
12

13
# Format, lint, and organize imports of all files
14
bunx biome check --write
15

16
# Format, lint, and organize imports of specific files
17
bunx biome check --write <files>

1
# Format specific files
2
deno run -A npm:@biomejs/biome format --write <files>
3

4
# Format all files
5
deno run -A npm:@biomejs/biome format --write
6

7
# Lint files and apply safe fixes to all files
8
deno run -A npm:@biomejs/biome lint --write
9

10
# Lint files and apply safe fixes to specific files
11
deno run -A npm:@biomejs/biome lint --write <files>
12

13
# Format, lint, and organize imports of all files
14
deno run -A npm:@biomejs/biome check --write
15

16
# Format, lint, and organize imports of specific files
17
deno run -A npm:@biomejs/biome check --write <files>

1
# Format all files
2
yarn exec biome format --write
3

4
# Format specific files
5
yarn exec biome format --write <files>
6

7
# Lint files and apply safe fixes to all files
8
yarn exec biome lint --write
9

10
# Lint files and apply safe fixes to specific files
11
yarn exec biome lint --write <files>
12

13
# Format, lint, and organize imports of all files
14
yarn exec biome check --write
15

16
# Format, lint, and organize imports of specific files
17
yarn exec biome check --write <files>

Editor integrations

Biome is available as a first-party extension in your favorite editors.

There are also community extensions for other editors, such as Vim, Neovim, and Sublime Text, to name a few.

Continuous Integration

Run biome ci as part of your CI pipeline to enforce code quality and consistency across your team. It works just like the biome check command, but is optimized for CI environments.

See the Continuous Integration recipes for more examples.

Next Steps

Success! You’re now ready to use Biome. 🥳

Migrate from ESLint and Prettier
Learn more about how to configure Biome
Learn more about how to use and configure the formatter
Learn more about how to use and configure the linter
Get familiar with the CLI commands and options
Get familiar with the configuration options
Join our community on Discord