# @0gfoundation/design-collab 中文文档

规范地址：https://npmcn.com/package/%400gfoundation/design-collab/

版本：0\.3\.5
npm 元数据更新时间：2026-10-21T02:58:53.580Z
中文译文更新时间：2026-11-08T10:02:58.165Z
软件包许可：ISC

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

原始 npm 页面：https://www.npmjs.com/package/%400gfoundation/design-collab
原文对照：https://npmcn.com/package/%400gfoundation/design-collab/?lang=original

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

- 包体积（解压后）：457 kB，56 个文件
- 模块格式：ES Module
- TypeScript 类型：未声明
- Node.js 要求：\>=20\.12\.0
- 运行依赖：0 个
- peer 依赖：storybook \>=10
- 首次发布：2026-09-01T03:29:36.234Z
- 最新版本发布：2026-10-13T07:34:22.462Z
- 近 30 天下载量：1808（2026-10-04 至 2026-11-02，npm 官方下载统计）
- 已发布版本数：11（近 12 个月 11 个）

## 中文简介

设计师/前端合作基础设施:每个承诺的"故事"(Sory Book),一个集成的设计门,以及从不接触设计师冲突的分支同步.

## 安装

```sh
npm install @0gfoundation/design-collab
```

也可以使用：`pnpm add @0gfoundation/design-collab`、`yarn add @0gfoundation/design-collab`、`bun add @0gfoundation/design-collab`

## README

# @ 0gfoundation/ design- collab

在共享代码库中用于设计者QQ前端协作的基础设施 : 每个承诺的故事书, 一个汇总设计门, 和分支同步 从来没有 将合并冲突交给设计师.

这里每张支票都是 **机制** 里面没有项目知识——"a View" 必须有一个兄弟的故事,"一个生成的艺术品必须与其来源相匹配", "这些识别器不能达到生产捆绑". 所有关于 __ 项目抵达 `design-collab.config.mjs`。这种分裂是整个 点:机制是便携式的,路径不是.

零运行时间依赖关系. 节点20.

> 中文的完整接入指南:[`ADOPTING.zh-CN.md`](https://npmcn.com/package/%400gfoundation/design-collab/ADOPTING.zh-CN.md) - 什麽 `init` 阅读和它拒绝猜测, 如何读取一个缺口, 以及每个 需要12张支票才能告诉你.

## 开始

```bash
pnpm add -D @0gfoundation/design-collab
```

在 npmjs 上公开, 因此没有其他配置—— 不 `.npmrc`,没有 在 CI 中注册符号, 您的部署平台中没有环境变量 。 然后说:

```bash
design-collab init             # writes the config; run it again to scaffold
                               # the agent skill and the CI workflow
design-collab install-drivers  # once per clone — see "Merge drivers" below
design-collab start            # before each piece of design work
```

`init` 故意两通 没有配置就没什么可填的 使用模板,所以第一个通过只写配置并停止。 曾经 已经编辑过, 第二次通过生成技能和工作流程 **从你的 数值**,因此这三件文物不能互相异议.

第一张通行证读取了您的寄存器,而不是复制一个例子: app 生活,您的源根,路径的别名 `tsconfig.json`键入检查 脚本,基部分支从 `origin/HEAD`无论你是否有故事书 i18n图书馆 at all. 它印出它发现的 和它不能,写 每个值旁边的文件中的原因。 任何无法观察的东西 **缺席而不是猜测** ——然后适用软件包的默认值,并适用漏洞 保持可见.

一个领域永远是你的: `writableSet` 写入为空, 而空集是 在装入时被拒绝 。 设计师的路径是决定,而不是财产 你的树.

## 收养不是沉默

无法运行的支票不会报告为已通过 。 曾经有三件事 输出中看起来完全相同, 现在不 :

|  | 失败了? |
| --- | --- |
| **已声明** 你写了 `checks: { 'message-parity': false }` | 不,这是答案 |
| **无** ——本行无任何相关变动 | 没有 |
| **差额** ——启用,无法运行 | **对** |

空白要么是缺少配置的检查,要么是运行 已审查 **零** 主题。 第二个曾经是危险的一个: 有光泽 描述不同的仓库, `view-stories` 报告 `PASS — 0 file(s) covered` 财务报告和审定财务报表 `design-wiring` 报告 `PASS — no source files under src`编辑 简言之 检查运行.

因此,摘要现在说明每个州同时——

```
[design-collab] 14 passed, 2 failed, 3 n/a.
```

——每一个缺口都与一个句子一起列出,该句子说要如何弥补. 配置它, 或者声明它不适用 。 两者都是答案,让它沉默就是 没有.

## 图标

|  |  |
| --- | --- |
| `start` | 写入代码前飞行: 节点版本对 `engines.node`分支地貌 血统 合并驱动 PR-body脚手架. |
| `check` | 每一个门CI运行,当地,报告 **全部** 一次失败. `--with-storybook` 准确的CI条. |
| `prepare` | 写下"故事书"读到的内容:合并的电文目录和"三个清单". `--skip-manifests` 用于一个应用程序建设, 它想要目录 而不是别的. |
| `sync` | 带一个设计分行更新——或停止干净,使树无动于衷. |
| `install-drivers` | 把驱动程序连接到这个克隆中. |
| `sb` | 决出一个承诺 从它建造的故事书. |
| `init` | 脚手架配置,代理技能和CI工作流程. |

## 设计公关必须在某个地方进行文件级检查

`check --shape-only` 仅运行分支形状的检查(名称、底部、行距、, 可写集,交接),并用于设计门,其项目 ALREADY 运行 `check --files-only` 在其一般的CI工作。 确保工作真的运行 设计公关 一个让设计公关便宜化的常用方法就是跳过一般的工作 并把它和 `--shape-only` 意思是爱斯林特和其他 文件级别检查在 CI 中没有运行 。 这个 参考项目运行的方式 20push设计PR。 当怀疑时,运行 满 `check` 在设计门内;大约花费20秒.

## `sync`,以及为什么它存在

一个能发现冲突并在那里停止的门 已经把问题推到了 人最没有这个能力 通常的升级——检查整合情况 分支、合并、决心、推动——不是设计者能够或应该做的.

`design-collab sync` 重起底盘 如果它不能这么干净 **中止并离开树枝** 从来没有一棵树充满 冲突标记——并打印一个手动信件,命名每个相冲突文件 是谁在基地里最后换的? 设计师不断设计,有人 前端上下文获得特定请求.

它重设基础而不是合并 因为一个将基础合并的设计分支 吸收该行的历史,然后与锁文件和 CI 配置相冲突 其作者从未打开. `check` 强制进行家族检查.

## 合并驱动程序

在设计工作流程中,大多数“冲突”不是分歧:

-   **i18n 目录** - 两个人加了两个人 _不同_ 键。 每个密钥合并 .
-   **设计符号** - 两个人加了两个人 _不同_ 自定义属性. 每个声明合并.
-   **出品文物** ——从来源重算而不是合并,因为 用手调和一个衍生文件就是做一个命令正确做的事情.

在一场真正的冲突中,所有三人都保留文件 **有效且可解析** 相当 而不是将冲突标记写入其中,并确切指明哪个键或 宣言需要一个人类.

> `install-drivers` 必须运行 **每个克隆人一次**。 。 。 . `.gitattributes` 绘制路径到 驱动程序并被执行; 驱动命令是本地的 git 配置, 不能 git拒绝执行带寄存器的指令,即: a 安全财产,而不是监督. `start` 检查它并告诉你.

## 配置

`design-collab.config.mjs` 在雷波根。 见 [`design-collab.config.example.mjs`](https://npmcn.com/package/%400gfoundation/design-collab/design-collab.config.example.mjs) - 没错 继续按目的完成 和双倍 作为计划文件.

需要的领域是: `appRoot` 财务报告和审定财务报表 `writableSet`。 。 。 . `writableSet` 没有 默认, 因为空集会拒绝任何更改和允许更改 这会让护道的装饰.

禁用任何名称的检查 : `checks: { 'view-stories': false }`。 。 。 .

### 关于软块的一个警告

这里的光彩执行 `(`, (中文(简体) ), `)`, (中文(简体) ), `[` 财务报告和审定财务报表 `]` 作为 **字节**这样 字符分类和交替不存在。 这是有意的:下一个 路由目录被命名 `(app)` 财务报告和审定财务报表 `[locale]`,并使用通用光谱 读取 `[locale]` 作为字符类,默默地无法匹配单曲 参考项目中最重要的路径.

## 故事书

`withDesignCollab()` 将故事书配置包成标签,标记自此以来更改的故事 种子 管理者静态进口 泰尔风V4 重写 `@theme` 改为 `@theme static` 因此,基金会的页面 显示活符 值,而不是僵硬的快照.

如果你的符号被分割到文件之间 `@import`,必须重写 **先用内线**: 尾风 v4 解析 `@import` 本身,所以导入的文件 永远不要将它作为自己的模块 变换永远不会看到 这个 匹配导入的文件名没有帮助 。 模板 `main.ts` 显示 工作形状.

`withDesignCollab()` 只有GUARANTES 列表存在——故事书没有 等待时 `main.ts`,所以它种子空的 而不是阻止启动在一基特 d. 重新发掘他们就是 `prepare`在故事书前的工作:

```json
"storybook":       "design-collab prepare && storybook dev -p 6006",
"build-storybook": "design-collab prepare && storybook build",
"build":           "design-collab prepare --skip-manifests && next build"
```

不要复制一个显示的生成器到您的工程中 `scripts/`。这就是 参考项目完成了,结果有~1200条线路生活在两地 没有比对它们 其他费用.

## 测试

```bash
node --test test/
```

合并驱动器和同步测试 **真实的 git 存储器**。 何谓 这些单位的承诺是一种行为 `git merge` 财务报告和审定财务报表 `git rebase`和一个模拟器 只能确认代码叫Git 和测试作者想象的一样 每个 驾驶员测试还声称: **基线** - 同一情况的冲突 _无_ - 因为否则绿色套房就无法区分 "the 司机的工作"从"没有碰撞过".

## 常见问题

### @0gfoundation/design-collab 是什么？

设计师/前端合作基础设施:每个承诺的"故事"\(Sory Book\),一个集成的设计门,以及从不接触设计师冲突的分支同步\.

### 如何安装 @0gfoundation/design-collab？

在项目目录运行 npm install @0gfoundation/design-collab，或使用 pnpm add / yarn add / bun add。它还提供命令行工具 design-collab，可以用 npx design-collab 直接运行。

### @0gfoundation/design-collab 支持 TypeScript 吗？

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

### @0gfoundation/design-collab 支持 ESM 还是 CommonJS？

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

### @0gfoundation/design-collab 需要什么版本的 Node\.js？

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

### @0gfoundation/design-collab 可以商用吗？

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

### @0gfoundation/design-collab 的下载量有多少？

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

### @0gfoundation/design-collab 还在维护吗？

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