入门指南

了解如何使用 Biome 搭建新项目。

Biome 最好作为你项目的开发依赖来安装，但它也可以作为独立可执行文件使用，后者无需 Node.js。

npm i -D -E @biomejs/biome

pnpm add -D -E @biomejs/biome

bun add -D -E @biomejs/biome

deno add -D npm:@biomejs/biome

yarn add -D -E @biomejs/biome

配置

尽管 Biome 可以在零配置下运行，但你多半会想调整一些设置以满足项目的需要。这种情况下，你可以运行以下命令来生成一个 biome.json 配置文件。

npx @biomejs/biome init

pnpx @biomejs/biome init

bunx --bun @biomejs/biome init

deno run -A npm:@biomejs/biome init

yarn exec biome -- init

用法

我们来快速了解一下如何在你的项目中使用 Biome。

命令行接口（CLI）

Biome 提供了一个命令行接口，用于格式化、Lint 和检查你的代码。

# 格式化所有文件
npx @biomejs/biome format --write

# 格式化指定文件
npx @biomejs/biome format --write <files>

# 对所有文件执行 Lint 并应用安全修复
npx @biomejs/biome lint --write

# 对指定文件执行 Lint 并应用安全修复
npx @biomejs/biome lint --write <files>

# 对所有文件执行格式化、Lint 并整理导入
npx @biomejs/biome check --write

# 对指定文件执行格式化、Lint 并整理导入
npx @biomejs/biome check --write <files>

# 格式化所有文件
pnpx @biomejs/biome format --write

# 格式化指定文件
pnpx @biomejs/biome format --write <files>

# 对所有文件执行 Lint 并应用安全修复
pnpx @biomejs/biome lint --write

# 对指定文件执行 Lint 并应用安全修复
pnpx @biomejs/biome lint --write <files>

# 对所有文件执行格式化、Lint 并整理导入
pnpx @biomejs/biome check --write

# 对指定文件执行格式化、Lint 并整理导入
pnpx @biomejs/biome check --write <files>

# 格式化所有文件
bunx --bun @biomejs/biome format --write

# 格式化指定文件
bunx --bun @biomejs/biome format --write <files>

# 对所有文件执行 Lint 并应用安全修复
bunx --bun @biomejs/biome lint --write

# 对指定文件执行 Lint 并应用安全修复
bunx --bun @biomejs/biome lint --write <files>

# 对所有文件执行格式化、Lint 并整理导入
bunx --bun @biomejs/biome check --write

# 对指定文件执行格式化、Lint 并整理导入
bunx --bun @biomejs/biome check --write <files>

# 格式化指定文件
deno run -A npm:@biomejs/biome format --write <files>

# 格式化所有文件
deno run -A npm:@biomejs/biome format --write

# 对所有文件执行 Lint 并应用安全修复
deno run -A npm:@biomejs/biome lint --write

# 对指定文件执行 Lint 并应用安全修复
deno run -A npm:@biomejs/biome lint --write <files>

# 对所有文件执行格式化、Lint 并整理导入
deno run -A npm:@biomejs/biome check --write

# 对指定文件执行格式化、Lint 并整理导入
deno run -A npm:@biomejs/biome check --write <files>

# 格式化所有文件
yarn exec biome format --write

# 格式化指定文件
yarn exec biome format --write <files>

# 对所有文件执行 Lint 并应用安全修复
yarn exec biome lint --write

# 对指定文件执行 Lint 并应用安全修复
yarn exec biome lint --write <files>

# 对所有文件执行格式化、Lint 并整理导入
yarn exec biome check --write

# 对指定文件执行格式化、Lint 并整理导入
yarn exec biome check --write <files>

编辑器集成

Biome 在你喜爱的编辑器中提供第一方扩展。

对于其他编辑器，还有社区扩展，例如 Vim、Neovim 和 Sublime Text 等。

持续集成（CI）

在你的 CI 流水线中运行 biome ci，以在整个团队中强制保证代码质量与一致性。它的用法与 biome check 命令相同，但针对 CI 环境做了优化。

更多示例请参阅持续集成配方。

下一步

大功告成！你现在可以使用 Biome 了。🥳

从 ESLint 和 Prettier 迁移
深入了解如何配置 Biome
深入了解如何使用和配置格式化器
深入了解如何使用和配置 Linter
熟悉 CLI 命令与选项
熟悉配置选项
加入我们的 Discord 社区