# @clearlydev/nx-archweave 中文文档

规范地址：https://npmcn.com/package/%40clearlydev/nx-archweave/

版本：0\.4\.0
npm 元数据更新时间：2026-11-07T03:41:59.631Z
中文译文更新时间：2026-11-10T00:56:53.895Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：469 kB，85 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=22\.18
- 运行依赖：2 个
- 首次发布：2026-10-18T04:34:18.805Z
- 最新版本发布：2026-11-07T03:41:59.394Z
- 近 30 天下载量：2127（2026-10-10 至 2026-11-08，npm 官方下载统计）
- 已发布版本数：11（近 12 个月 11 个）

## 中文简介

用于FSD Lite lint 规则的 Nx 生成器, 前端/后端边界, AI代理规则, GitHub 模板和可选 AI PR 审查

## 安装

```sh
npm install @clearlydev/nx-archweave
```

也可以使用：`pnpm add @clearlydev/nx-archweave`、`yarn add @clearlydev/nx-archweave`、`bun add @clearlydev/nx-archweave`

## README

# @ clearlydev/nx-archweave (英语)

Nx 生成器, 可以使用一个预设工作空间 :

-   前端应用程序层的 FSD 升降规则(`warn` 或者说 `error` 加上切片发电机
-   前端/后端边界作为它标记的工程之间的提示出错, 当有后端时
-   AI 代理规则
-   GitHub 模板
-   与您选择的提供者一起进行 AI PR 选项审查( 支持 Claude; 双子座、 GPT 和 Cursor in β)

开始全新的工作空间? 使用 [`create-nx-archweave`](https://www.npmjs.com/package/create-nx-archweave)。它创建工作空间,安装此插件,并运行 `init`都在一个命令里.

## 安装

在工作空间根处运行其中之一, 与工作空间的软件包管理器 :

```bash
npm install -D @clearlydev/nx-archweave        # npm
pnpm add -D -w @clearlydev/nx-archweave        # pnpm
yarn add -D @clearlydev/nx-archweave           # yarn berry (yarn 1: add -W)
bun add -d @clearlydev/nx-archweave            # bun
```

然后确认安装. `doctor` 只读 :

```bash
npm exec nx -- g @clearlydev/nx-archweave:doctor   # npm
pnpm nx g @clearlydev/nx-archweave:doctor          # pnpm
yarn nx g @clearlydev/nx-archweave:doctor          # yarn
bun nx g @clearlydev/nx-archweave:doctor           # bun
```

-   **所需经费:** 节点+22.18,外加npm,pnpm+10,纱线(经典或莓花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花花 四个包经理都是一流的.
-   发电机从它的锁文件中检测到工作空间真正的软件包管理器.
-   以下实例 `pnpm nx g`。用另一个软件包管理器,运行同样的生成器 `doctor` 上方命令显示.
-   包裹是用自己的密码装的 它的运行时间依赖性是 `@nx/devkit` 财务报告和审定财务报表 `jsonc-parser`,nx已经依赖于同一版本.

## 快开始

先预览全程. 这没有写到:

```bash
pnpm nx g @clearlydev/nx-archweave:init --preset=team --frontend=next --dryRun
```

那就认真运行吧

```bash
pnpm nx g @clearlydev/nx-archweave:init --preset=team --frontend=next
```

-   `init` 根据预设运行下面的内容生成器( e)`quick-start` | `solo` | `team`) (中文(简体) ).
-   `init` 需要一个干净的 git 工作树, 因此部分运行可以完全被撤销 : 报告列出它修改的文件(`git restore -- …`)和它创建的文件.
-   `--allowDirty` 选择退出清洁树种检查。 然后报告警告你,回滚范围更广.
-   `--locale=ko|en` 设置生成内容的语言。 报告总是用英文.

## 发电机

| 发电机 | 它会做什么 |
| --- | --- |
| `init` | 运行五 `add-*` 通过预设的发电机 |
| `doctor` | 仅读诊断;从未写过 |
| `add-fsd-lite` | FSD 边界 ESLint 规则中的线条 |
| `add-agent-rules` | 将规则写入每个 AI 主机的文件 |
| `add-github-templates` | 发行表格、公关模板、CODEOWNERS |
| `add-review` | AI 公关审查工作流程 |
| `add-backend` | 将后端应用程序线入 |
| `page` 编号 : `widget` 编号 : `feature` 编号 : `entity` 编号 : `shared` | 脚手架 FSD 切片或片段 |
| `add-integration` | 预览目录插件安装流程 |
| `install-integration` | 安装目录插件( 有) `--apply`(中文(简体) ) |
| `record-integration` | 记录您手动安装的插件 |
| `allow-builds` | 只有 pnpm: 允许跳过构建脚本 |

在以下选项列表中:

-   \* 标出所需选项.
-   † 标出一个需要到 `init` 已经录入 `toolkit.config.json`。在此之后,如果将其排除在外,生成器会使用记录值.

### `init`

5号公路上的预设管道 `add-*` 发电机: `add-fsd-lite`, (中文(简体) ), `add-agent-rules`, (中文(简体) ), `add-github-templates`, (中文(简体) ), `add-review` 财务报告和审定财务报表 `add-backend`跑完后, `init` 进行最有效的验证(行动lint, `nx graph`) (中文(简体) ).

选项 : `--preset`†, `--frontend`†, `--backend`, (中文(简体) ), `--packageManager`, (中文(简体) ), `--locale`, (中文(简体) ), `--aiHosts`, (中文(简体) ), `--reviewProvider`, (中文(简体) ), `--fsd`, (中文(简体) ), `--agentRules`, (中文(简体) ), `--githubTemplates`, (中文(简体) ), `--review`, (中文(简体) ), `--applyEslint`, (中文(简体) ), `--allowDirty`, (中文(简体) ), `--dryRun`

### `doctor`

唯读诊断. `doctor` 从不写 它检查:

-   工作空间、软件包管理器和框架检测
-   nx 版本范围
-   边界标记是否存在
-   FSD 类似结构
-   审查一致性
-   漂移状态

选项 : `--liveIntegrations`, (中文(简体) ), `--json`

### `add-fsd-lite`

连接 `archweave/fsd-boundaries` ESLint规则进入前端app的配置. 规则是 `@clearlydev/nx-archweave/eslint`。 。 。 .

-   与 `--applyEslint`,生成器会写入配置。 没有它,你得到一个糊状准备片段.
-   一个未识别的配置从未被编辑 .
-   打印层向导(下册: `pages` → `_pages/`) (中文(简体) ).
-   没有创建文件夹.
-   `--steiger` 添加正式的 FSD 插件为选入 `fsd-check` 目标(节点22.18).

选项 : `--frontend`†, `--project`, (中文(简体) ), `--enforcement`, (中文(简体) ), `--applyEslint`, (中文(简体) ), `--steiger`, (中文(简体) ), `--locale`, (中文(简体) ), `--dryRun`

### `add-agent-rules`

每个AI主机将 nx-archweave 的规则写成文件中的一个标记块:

-   `CLAUDE.md` 克劳德代码
-   `AGENTS.md` 用于编码、光标和双子座CLI

发电机从不碰周围的文字.

选项 : `--hosts`, (中文(简体) ), `--teamRules`, (中文(简体) ), `--locale`, (中文(简体) ), `--dryRun`

### `add-github-templates`

添加 GitHub 发行表,一个PR模板和CODEOWINERS. 生成器总是跳过已经存在的文件 .

选项 : `--issue`, (中文(简体) ), `--pr`, (中文(简体) ), `--codeowners`, (中文(简体) ), `--locale`, (中文(简体) ), `--dryRun`

### `add-review`

安装 AI PR 审查工作流程和 `review` 输入 `toolkit.config.json`。 。 。 .

-   `--provider`, (中文(简体) ), `--mode`, (中文(简体) ), `--maxRounds`: 如果您不保留一个, 生成器会使用已记录的值
-   `--onConflict`, (中文(简体) ), `--locale`, (中文(简体) ), `--dryRun`

### `add-backend`

电线后端app in :

-   (单位:千美元) `shared-types` 独立
-   `scope:` 标记
-   边界限制(仅写为 `--applyEslint`(中文(简体) )

如果 `api` 工程缺失, 生成器拒绝, 并给出了复制和粘贴的官方命令 .

选项 : `--backend`\* \*, `--apiName`, (中文(简体) ), `--frontendProject`, (中文(简体) ), `--applyEslint`, (中文(简体) ), `--dryRun`

### `page` 编号 : `widget` 编号 : `feature` 编号 : `entity` 编号 : `shared`

`page`, (中文(简体) ), `widget`, (中文(简体) ), `feature` 财务报告和审定财务报表 `entity` 脚手架一分: `index.ts` + 键 `model/`附加时 `--segments` 额外. `shared` 脚手架是专门命名的 每个生成器在应用中写到自己的地层:

-   `page` → `src/pages` (单位:千美元)`_pages` 下册.js)
-   `widget` → `src/widgets`
-   `feature` → `src/features`
-   `entity` → `src/entities`
-   `shared` → `src/shared`

如果缺少,所有五台发电机都会创建层目录,跳过同名的切片,然后检查 `--publicApiName` 是一个可用的标识符.

-   选项 : `--name`\* \*, `--publicApiName`, (中文(简体) ), `--segments`, (中文(简体) ), `--project`, (中文(简体) ), `--locale`, (中文(简体) ), `--dryRun`
-   `--segments` 无法在 `shared`,因为片段就是这个名字.
-   `page` 还要 `--frontend`。 。 。 .

### `add-integration`

**仅预览.** 显示目录插件的官方安装流程:出处,许可,手动步骤和未安装. `add-integration` 安装无并写入无.

选项 : `--tool`\* \*, `--target`, (中文(简体) ), `--scope`, (中文(简体) ), `--versionRange`, (中文(简体) ), `--dryRun`

### `install-integration`

与 `--apply`, (中文(简体) ), `install-integration`数字 :

-   运行主机的官方 CLI 安装目录插件( 默认的项目范围)
-   重新验证安装实况
-   记录显示的条目
-   声明工具在 `toolkit.config.json`

无 `--apply`预览.

选项 : `--tool`\* \*, `--target`, (中文(简体) ), `--scope`, (中文(简体) ), `--versionRange`, (中文(简体) ), `--apply`

### `record-integration`

验证手动完成的安装实况 。 与 `--apply`,它记录了准确的一个条目 `archweave-integrations.json`,并且只有在权威信号成功时才使用.

选项 : `--tool`\* \*, `--target`, (中文(简体) ), `--apply`

### `allow-builds`

仅限pnpm。 允许依赖者构建 pnpm 跳过或被告知拒绝的脚本 。 与 `--apply`, (中文(简体) ), `allow-builds` 将这些软件包设定为 `true` 内 `pnpm-workspace.yaml` 运行 `pnpm rebuild`没有 `--apply`预览.

选项 : `--packages`\* \*, `--apply`

## 预设

|  | `quick-start` | `solo` | `team` |
| --- | --- | --- | --- |
| FSD 字节 | 打开 | 打开 | 打开 |
| FSD 规则严重性 | `warn` | `warn` | `error` |
| 代理规则 | aI 主机文件 | aI 主机文件 | aI 主机文件 + 团队规则 部分 |
| GitHub 模板 | 只公关 | 只公关 | 问题+PR |
| 审查默认 | 关闭( opt- in) | 打开 | 打开 |
| 审查模式 | `fast` | `fast` | `standard` |

明确的旗帜总是胜过预设的默认.

## AI 公关审查

检讨是完全可选的,与一个提供者无关.

-   禁止审查的,出品为零审查文物.
-   如果允许审查, 工作流程 **绿滑** 直到你登记提供者的秘密为止.
-   圆标在工作流程后停止 `--maxRounds` 每个 PR (1–5, 默认 3) 审查 。 后犯没有AI的判决,所以 `review` 检查失败; 将其与分支规则的绕行合并 .

| `--provider` | 工作流程文件 | 必需的秘密 |
| --- | --- | --- |
| `claude` (默认) | `.github/workflows/claude-code-review.yml` | `CLAUDE_CODE_OAUTH_TOKEN` |
| `gemini` (贝塔) | `.github/workflows/gemini-code-review.yml` | `GEMINI_API_KEY` |
| `gpt` (贝塔) | `.github/workflows/gpt-code-review.yml` | `OPENAI_API_KEY` |
| `cursor` (贝塔) | `.github/workflows/cursor-code-review.yml` | `CURSOR_API_KEY` |

每个供应商都检查过什么,在哪里得到它的秘密和已知的问题: [提供者状态](https://github.com/clearlydev/nx-archweave/blob/main/docs/pr-review.md#provider-status)。 。 。 .

模式 :

-   `fast` 财务报告和审定财务报表 `standard` 审查正确性和安全性.
-   `thorough` 增加了超工程通行证.

调查结果按捆绑审查政策列为优先事项.

## 行为合同

每个发电机都遵守四项承诺:

-   `--dryRun` 全部预览并写入任何内容.
-   以相同内容报告"不变"再次运行.
-   一个不成功的前提条件产生拒绝报告,而不是例外.
-   冲突从来不是沉默地掩盖的.

## 每个 AI 主机的可选插件( 实验性)

3台发电机使用审查过的插件 **目录**数字 :

-   `add-integration` 预览插件.
-   `install-integration` 安装插件( 有 `--apply`) (中文(简体) ).
-   `record-integration` 记录一个插件.

安装通过AI主机自己的正式安装器,默认为项目范围.

-   该目录为数据. Claude Code是今天唯一拥有适配器的宿主 [马尾](https://github.com/DietrichGebert/ponytail) 这是它的第一个条目.
-   录音需要直播 `claude plugin list --json` 确认插件已安装的信号 **财务报告和审定财务报表** 启用 .
-   被禁用的插件,模棱两可的匹配或CLI出错产生零写,从不假"被验证".
-   `doctor` 报告每个插件的宣告、记录和检测状态. `--liveIntegrations` 重新验证现场.
-   这里没有运行 除非你问.

## 再来

完整的文档和韩国的README在 [仓库](https://github.com/clearlydev/nx-archweave)。 。 。 .

## 捐款

-   `nx build @clearlydev/nx-archweave` 运行 tsc,用于本地 dev 和类型检查 .
-   `nx test` 运行杰斯特.
-   `nx bundle` (取决于 `build`制作可出版的装入 `dist/`。内部工作空间包是内嵌的,所以柏油球没有 `workspace:` 道诸相.
-   `prepack` 重新运行 `bundle` 和条 `workspace:` 范围仅从包装的明细表。 这是中断安全: `postpack` 恢复上盘 `package.json`。 。 。 .
-   为了核实一个释放候选人,竞选 `node tools/verify-tarball.mjs` 在雷波根.

## 许可证

麻省理工学院

## 常见问题

### @clearlydev/nx-archweave 是什么？

用于FSD Lite lint 规则的 Nx 生成器, 前端/后端边界, AI代理规则, GitHub 模板和可选 AI PR 审查

### 如何安装 @clearlydev/nx-archweave？

在项目目录运行 npm install @clearlydev/nx-archweave，或使用 pnpm add / yarn add / bun add。它还提供命令行工具 archweave-review-verdict，可以用 npx archweave-review-verdict 直接运行。

### @clearlydev/nx-archweave 支持 TypeScript 吗？

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

### @clearlydev/nx-archweave 支持 ESM 还是 CommonJS？

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

### @clearlydev/nx-archweave 需要什么版本的 Node\.js？

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

### @clearlydev/nx-archweave 可以商用吗？

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

### @clearlydev/nx-archweave 的下载量有多少？

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

### @clearlydev/nx-archweave 还在维护吗？

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