# @devbie/style-guide 中文文档

规范地址：https://npmcn.com/package/%40devbie/style-guide/

版本：1\.6\.0
npm 元数据更新时间：2026-11-10T13:44:50.731Z
中文译文更新时间：2026-11-12T03:45:54.084Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40devbie/style-guide
原文对照：https://npmcn.com/package/%40devbie/style-guide/?lang=original
项目主页：https://github.com/worldzhy/devbie#readme
源码仓库：https://github.com/worldzhy/devbie

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

- 包体积（解压后）：15.1 kB，9 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=20
- 运行依赖：5 个
- peer 依赖：next ^16\.0\.0，eslint ^9\.0\.0 \|\| ^10\.0\.0，prettier ^3\.9\.9，typescript \>=5\.0\.0
- 首次发布：2026-10-21T00:09:38.887Z
- 最新版本发布：2026-11-10T13:44:50.517Z
- 近 30 天下载量：3024（2026-10-12 至 2026-11-10，npm 官方下载统计）
- 已发布版本数：13（近 12 个月 13 个）

## 中文简介

Devbie 生态系统代码风格的单一真源:共享更漂亮的配置和可混凝土的 Eslint平地层(基,巢,下)

## 安装

```sh
npm install @devbie/style-guide
```

也可以使用：`pnpm add @devbie/style-guide`、`yarn add @devbie/style-guide`、`bun add @devbie/style-guide`

## README

# @ devbie/ style-guide (英语)

整个 devbie 生态系统代码样式的单一真理源 (新出/数出/出. 见ADR-010 in `worldzhy/devbie`。 。 。 .

## 出口

| 条目 | 目录 |
| --- | --- |
| `@devbie/style-guide/prettier` | Canonic 更漂亮的配置( 所有重置) |
| `@devbie/style-guide/eslint/base` | 节点类型平面配置基线 |
| `@devbie/style-guide/eslint/nest` | 巢层(最特定规则,类型意识) |
| `@devbie/style-guide/eslint/next` | Next.js 层 (canonical Next.js 规则) |

`nest` 财务报告和审定财务报表 `next` 为: **层,而不是单独的标准**: 每个消费者 编曲 `[...base, ...nest]` 或者说 `[...base, ...next]`基线携带 共享语言级别规则并更漂亮; 一层只添加其 框架规则. `base` 仅涵盖国家清单、代码生成器、登记册和 SDKs (英语).

## 涵盖范围:每个回波使用的条目

| 还原 | 组成 |
| --- | --- |
| devbie 单列波根 | `base` + 键 `nest` 范围为 `packages/newbie` |
| 新启动器 | `base` + 键 `nest` |
| 数比启动器 | `base` + 键 `next` |
| 新单元 | `base` + 键 `nest` |

本表有两个结构事实:

-   `newbie-modules` 是一个纯源登记册——模块源被复制到 消费者而不是建筑在原地 但这些来源是巢穴密码,所以 它会编曲 `[...base, ...nest]` 与 `injectable-should-be-provided` 缩小范围:登记册中没有用于规则的宿主模块图表 解析提供方对齐,主机将规则保留在允许的地方 图表存在.
-   Devbie 单列波根在一个配置中表示不同的包: `packages/newbie` 是巢穴框架代码,而CLI、生成器和 sDK是简单的节点 ESLint 平面配置不读 `package.json` 财务报告和审定财务报表 筑巢 `eslint.config.mjs` 文件没有继承, 所以每个包 区分必须在根配置中表示 `files` 范围界定 - 从未使用每包配置文件或 `package.json` 输入字段.

`next` (和 `nest`)必须装入框架的软件包 已安装 : `eslint-config-next` 需求 `next` 载荷时间(宣布为 可选的对等点,因此基础/nest消费者从不被迫安装Next.js, 和 Nest 层需要一个 TypeScript 工程,用于其四个类型意识 规则。 Nest 插件本身的对等声明包含其余内容——无 进口 `class-validator` 在运行时间.

## 使用量

### 更美丽

删除任何本地 `.prettierrc` 并引用共享配置 `package.json`数字 :

```json
{
  "prettier": "@devbie/style-guide/prettier"
}
```

`.prettierignore` 保留repo本地:它列出了repo特有的建筑文物, 不是风格决定.

### 斯林特(平面配置)

`eslint.config.mjs` 在消费回收中:

```js
import base from "@devbie/style-guide/eslint/base";
// Nest apps:      import nest from "@devbie/style-guide/eslint/nest";
// Next.js apps:   import next from "@devbie/style-guide/eslint/next";

export default [
  ...base,
  // ...nest or ...next, then repo-specific rules and ignores.
];
```

消费者需要 `eslint` (^9或^10), (中文(简体) ), `prettier` (^ 3.9.9)和 (中文(简体) ) `typescript` 安装为自己的 dev 依赖(声明为此软件包的同级).

## 版本政策

所有Devbie软件包在生态系统发射前一直停留在1.x线上; 断开样式变化起伏微小,而非主大小。 主要升级 更漂亮/更深层遵循整个生态系统的主要冻结政策: 默认,只是故意的里程碑.

## 更改日志

-   1.4.1-任择条款 `next` 拓宽到 `^16.0.0`1.4.0 申报 `^16.4.2` (模仿本软件包自身测试所使用的 dev 依赖性) npm对已安装的拷贝执行可选对等范围,所以 next.js 16.2上的消费者未能安装ERESOLVE。 现在的同伴 说明实际合同:任何Next.js 16.
-   1.4.0——三项埃斯林特入船申报(出口图) `types` 并行 `default`页:1 `next` 关闭层开关 `import/no-anonymous-default-export` 页:1 `eslint.config.*` 文件是这样 消费者可以使用平庸的 `export default [...base, ...next]`。 。 。 . `next` 被宣布为可选对等点.
-   1.3.1 内部 `core` 插入条目 `base` 并删除。 没什么 直接导入( e)`base` {\\fn黑体\\fs22\\bord1\\shad0\\3ahbe\\4ah00\\fscx67\\fscy66\\2chffffff\\3ch808080}是它唯一的消费者 {\\fn黑体\\fs22\\bord1\\shad0\\3ahbe\\4ah00\\fscx67\\fscy66\\2chffffff\\3ch808080}保存两份档案 对于一个条目集,加载命令更难读取: `nest` 财务报告和审定财务报表 `next` 每个结束 `prettierConfig`,所以没有共享尾巴来考虑.
-   1.3.0——新设 `nest` 层由 `@darraghor/eslint-plugin-nestjs-typed` (建议平面配置,四种类型意识规则),并 `next` 重塑成一个 层。 消费者现在作曲 `[...base, ...nest]` 编号 : `[...base, ...next]`· ; 这也让devbie monorepo 覆盖 Nest 层到 `packages/newbie` 通过 `files` 而不是把巢穴框架标准赋予其国家领导机构.
-   1.2.0 -- -- 目标 `backend` 重新命名为 `base` 财务报告和审定财务报表 `frontend` 已删除。 之后的坑和 newbie-cli加入新单曲(ADR-012/ADR-015), `frontend` 没有 消费者左,并 `backend` 不再描述其消费者(CLI,代码) \* 发电机、登记册——无后端。 双子现在被命名为 是什么来着 `base` (默认)和 `next` (下个Js专业). 放弃反应/反应-hooks/jsx-a11y插件依赖性; `next` 获取这些层 从 `eslint-config-next`。 。 。 .
-   1.1.3. 国家 `frontend` 针入规则评价的反演版本( 19. 0) 而不是 检测到它: 少许bie lints React 模板源 `react` 包已安装,其中检测只发出警告.
-   1.1.2——固定: `next` 扩展 `core` 加上警犬 下一个规则集 (单位:千美元)`eslint-config-next` 已经捆绑了 React/ react-houks/jsx-a11y,所以 传播 `frontend` 在顶端重新定义 `jsx-a11y` 并拒绝平面配置 ) (中文(简体) ). 这个 `frontend` 反应层现在被设定为 JSX/TSX 文件,所以节点代码 前端重播时不按反应规则评价,而按反应模板 来源是.
-   1.1.1——固定: `frontend` 使用 eslint-plugin- react-hooks 的平面变体 (单位:千美元)`configs.flat["recommended-latest"]`); 1.1.0 运出遗留形状和 在平面配置下加载失败 .
-   1.1.0——条目更名为 `backend` 编号 : `frontend` 和分层 : `core` 实值 内部, `frontend` 框架独立(只有反应规则), `next` 添加了 Canonical Next.js 规则集. `nest` 改为: `backend`。 。 。 .
-   1.0.0——初步释放(`prettier`, (中文(简体) ), `eslint/nest`, (中文(简体) ), `eslint/next`) (中文(简体) ).

## 常见问题

### @devbie/style-guide 是什么？

Devbie 生态系统代码风格的单一真源:共享更漂亮的配置和可混凝土的 Eslint平地层\(基,巢,下\)

### 如何安装 @devbie/style-guide？

在项目目录运行 npm install @devbie/style-guide，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：eslint（^9\.0\.0 \|\| ^10\.0\.0）、prettier（^3\.9\.9）、typescript（\>=5\.0\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @devbie/style-guide 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @devbie/style-guide 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @devbie/style-guide 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=20。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @devbie/style-guide 可以商用吗？

@devbie/style-guide 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @devbie/style-guide 的下载量有多少？

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

### @devbie/style-guide 还在维护吗？

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