Biome工作原理

这一指南旨在解释工具是如何工作的，原理以及在配置项目和配置文件时有所帮助的内部信息。

配置

配置文件被认为是可选的，Biome有很好的默认值。使用配置文件来更改这些默认值。

Biome的配置文件名为biome.json，应放置在项目的根目录中。根目录通常是包含项目的package.json的目录。

此配置文件启用了格式化工具，并设置了首选的缩进样式和宽度。禁用了代码检查器：

{
  "formatter": {
    "enabled": true,
    "indentStyle": "tab",
    "lineWidth": 120
  },
  "linter": {
    "enabled": false
  }
}

默认配置

运行biome init时，生成的默认配置如下：

{
  "organizeImports": { "enabled": true },
  "linter": {
    "enabled": true,
    "rules": { "recommended": true }
  }
}

配置文件解析

Biome使用自动发现来查找最近的biome.json文件。它从当前工作目录开始查找biome.json，然后向上级目录查找，直到：

找到biome.json文件；
如果找不到biome.json文件，则应用Biome的默认值；

以下是一个示例：

└── app
    ├── backend
    │   ├── package.json
    │   └── biome.json
    └── frontend
        ├── legacy
        │   └── package.json
        ├── new
        │   └── package.json
        └── biome.json

在app/backend/package.json中运行的biome命令将使用配置文件app/backend/biome.json；
在app/frontend/legacy/package.json和app/frontend/new/package.json中运行的biome命令将使用配置文件app/frontend/biome.json；

已知文件

以下文件目前被Biome忽略。这意味着Biome不会为这些文件发出任何诊断信息。

package.json
package-lock.json
npm-shrinkwrap.json
yarn.lock
composer.json
composer.lock
typescript.json
tsconfig.json
jsconfig.json
deno.json
deno.jsonc

以下文件被解析为**JSON文件**，选项json.parser.allowComments和json.parser.allowTrailingCommas设置为true。这是因为像VSCode这样的编辑器工具将其视为这种格式。

tslint.json
babel.config.json
.babelrc.json
.ember-cli
typedoc.json
.eslintrc
.eslintrc.json
.jsfmtrc
.jshintrc
.swcrc
.hintrc
.babelrc