# @canonical/biome-config 中文文档

规范地址：https://npmcn.com/package/%40canonical/biome-config/

版本：0\.44\.0
npm 元数据更新时间：2026-10-23T01:39:35.425Z
中文译文更新时间：2026-11-09T07:54:00.715Z
软件包许可：LGPL-3\.0

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40canonical/biome-config
原文对照：https://npmcn.com/package/%40canonical/biome-config/?lang=original
项目主页：https://github.com/canonical/pragma-core#readme
源码仓库：https://github.com/canonical/pragma-core

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：25.6 kB，5 个文件
- TypeScript 类型：未声明
- 运行依赖：0 个
- peer 依赖：@biomejs/biome 2\.5\.15
- 首次发布：2024-11-08T18:28:27.635Z
- 最新版本发布：2026-10-23T01:39:35.059Z
- 近 30 天下载量：3816（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：57（近 12 个月 35 个）

## 中文简介

这是一个 [生物体](https://biomejs.dev/) 为Biome项目提供一组默认配置的配置.

## 安装

```sh
npm install @canonical/biome-config
```

也可以使用：`pnpm add @canonical/biome-config`、`yarn add @canonical/biome-config`、`bun add @canonical/biome-config`

## README

# @ canonical/ biome- config

这是一个 [生物体](https://biomejs.dev/) 提供配置 biome 项目的一组默认配置.

## 安装

1.  安装 [生物体](https://biomejs.dev/)数字 : `bun add -d @biomejs/biome`
2.  安装配置 : `bun add -d @canonical/biome-config`

## 旋转

创建 `biome.json` 并扩展此配置.

```json
{
  "$schema": "https://biomejs.dev/schemas/2.5.11/schema.json",
  "extends": [
    "@canonical/biome-config"
  ],
  "files": {
    "include": [
      "src",
      "*.json"
    ]
  }
}
```

运行 `biome` 命令。 将应用基础配置.

示例 `package.json` 下文提供脚本.

```jsonc
{
  "scripts": {
    "check": "biome check",
    "format": "biome format",
    "lint": "biome lint"
  }
}
```

## 配置

此配置允许以下行为 :

1.  格式规则
    1.  双相距缩进
    2.  双引号字符串
2.  有组织的进口
3.  默认情况下应用 Biome 推荐的林克规则
4.  禁用版本控制集成: 不与 Git 交互
    1.  忽略 `.gitignore`:明确包括所有文件,除非它们被人工忽略或明确包括其他文件.
    2.  忽略 Git 添加状态 : 运行前不需要设置文件 `biome check` 或者说 `biome format`。 。 。 .
5.  忽略检查所有文件 `node_modules` 财务报告和审定财务报表 `dist` 目录. 请注意,如果您使用 `files.ignore` 内 `biome.json`,你会推翻这个行为.

### 洞穴

#### 单曲

Biome尚未完全支持单体. 使用 Biome 和 IDE 插件,如果您在单列中工作,它们可能不会像预期的那样工作 . 作为一个工作, [Biome建议](https://biomejs.dev/guides/big-projects/#monorepos) 包括以下项目: `biome.json` 地点 单存的根,并使用 `overrides` 以指定子包的任何例外.

#### 语文支助

Biome仍在开发中,可能不会支持所有语言或特征. 我们建议检查 [Biome 支持的语言列表](https://biomejs.dev/internals/language-support/) 确保您的项目获得支持.

##### 丝绒

包括斯维尔特特特制的超接功能,因为Biome还没有支持"跨语言"的lint行为,这可以产生假阳性 `noUnusedVariables`, (中文(简体) ), `noUnusedImports`, (中文(简体) ), `useImportType`,以及 `useConst`。 。 。 .

这些插件是暂时的,应该删除一次 [生物网点/生物网点# 8590](https://github.com/biomejs/biome/issues/8590) 已经解决.

我们直接把这些控制器放进去 `@canonical/biome-config` (而不是在单独的斯维尔特特定配置包中),因为Biome配置扩展不是过渡性的. 其他上下文见 [第449号公关](https://github.com/canonical/pragma-web/pull/449)。 。 。 .

## 常见问题

### @canonical/biome-config 是什么？

这是一个 生物体 为Biome项目提供一组默认配置的配置\.

### 如何安装 @canonical/biome-config？

在项目目录运行 npm install @canonical/biome-config，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：@biomejs/biome（2\.5\.15）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @canonical/biome-config 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/canonical\_\_biome-config 是否存在。

### @canonical/biome-config 可以商用吗？

@canonical/biome-config 使用 LGPL-3\.0 许可。弱 Copyleft：作为库被调用时通常不要求开源你自己的代码，但修改库本身需以 LGPL 开源；前端打包合并后的适用边界存在不同理解。以上为概括，不构成法律意见，请以许可原文为准。

### @canonical/biome-config 的下载量有多少？

根据 npm 官方下载统计，@canonical/biome-config 在 2026/10/09 – 2026/11/07 这 30 天内被下载 3,816 次，日均约 127 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @canonical/biome-config 还在维护吗？

最新版本 0\.44\.0 发布于 2026/10/23（17 天前）；至今共发布 57 个版本，其中过去 12 个月发布了 35 个；首次发布于 2024/11/09。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。