English · 简体中文

Normify · 归一化框架图构建器

把整个项目描述成一棵"人机共读"的分形模块树：AI 负责分析与创作，确定性引擎负责校验、编译与渲染 —— 点开任意模块，就是一张更精细的子图。

0. 一句话

Normify 是 DeepSeek Harness（DSH）插件，也是一套写给 AI 用的开发流程：

• 给 AI 的：normify-gen 技能 + 31 个 normify_* 工具 —— 让模型把仓库分析成模块树结构数据， 并在后续开发中先建图后编程、伴随编程改图（计划态建树 → 逐个实现 → 关单收尾）。
• 给引擎的：零容忍校验（L1 写时 / L2 全项目 / L3 冻结）+ 确定性编译（tree.json 等四件产物，SHA-256 冻结）
  • 渲染数据（renders/，决定"每一层怎么画"）。
• 给人的：单文件交互式架构图（normify.html）—— 逐层下钻、悬停看介绍、一键中英切换、深链接、 多树、API 直连箭头、跨层聚合、缩放与搜索。零依赖，双击即开。

它不是"生成一张图就结束"的工具：结构数据与代码互为契约，每次改动都能被 normify_sync 检出漂移， 并以 normify_change_close（0 error 强制）收尾，让"代码 → 架构图"永远同步。

_{引擎层：14 个模块、API 直连箭头（箭头锚定到具体 API 行）、带标签的子系统依赖、跨层聚合虚线}

1. 它解决什么问题

2. 核心特性

2.1 数据模型：分形 + 零冗余

• 唯一元素：整个数据库由无数个结构完全相同的基本模块构成（每个模块 = 一个 Markdown 文件）。
• 只存 parent：单方向引用，children 由索引导出 —— 不会出现"父子各说各话"。
• API 只在叶子存一次：聚合、统计、索引全部是编译期派生数据（tree.json / api-index.json）。
• 两类边：containment（树边，导航骨架）+ dependency（箭头，可跨子树、跨树，按 kind 着色）。
• 路径式 id + 不变 uid：AI 沿 id 逐层定位（类二分查找）；uid 在改名/移动时保持不变，git diff 稳定。
• 深度不设上限（0.5.0 起）：想有多细就拆多细，深度不再成为"合并模块"的理由。

2.2 三层校验，fail-closed

每条诊断都带 severity / code / message / subject / evidence / supportedFixes —— AI 可自行修复。

2.3 渲染器：单文件、可下钻、API 直连

• 单文件 HTML（内联 CSS/JS，零外部依赖、零遥测），双击即开，可直接归档/发人。
• 逐层下钻 + 面包屑 + 搜索（模块名/API）+ 大纲视图 + API 浏览器。
• API 直连：叶子框内展示 API 明细行，箭头锚定到具体 API 行的端口；同一 API 行上的多条边自动扇形分离。
• 跨层依赖聚合为虚线 ×N（默认隐藏，工具栏或 ?agg=1 开启，悬停看明细）。
• 深链接：#module=<id>、#api=<rpc:key>、#view=outline、?lang=zh|en、?agg=1；缩放 / 悬停高亮 / 明暗主题。
• 几何自检：仓库自带 check-geometry.mjs，逐层断言"线不出界 / 不贴框 / 不穿框 / 不压线"。

2.4 伴随开发：先建图后编程

change_open → brief → check → module_batch(state=planned) → 【写代码】
   → module_refresh(activate) → change_close(0 error 强制) → verified + revision.after

• 计划态：源码还不存在也能先建树（fingerprint: pending），validate 放行；
• 禁止假激活：源码没落地就 activate 直接被拒；
• 收尾即闭环：change_close 会刷新指纹 → 校验（0 error 强制）→ 编译（可选渲染）→ 标记 verified， 任何一步失败都不关闭，变更保持原状态；
• 改图随代码：normify_sync 用 git diff + 未跟踪文件定位受影响模块与指纹漂移，module_patch 跟随更新。

2.5 架构规则先行（policy.yml）

安装后 normify_validate / normify_build / normify_check 全部强制执行；违规先改设计，不能绕过。

3. 最新变化

v0.5.4 · 把"第二轮 A/B 实测"暴露的 4 个工具缺陷修掉（当前版本）

第二轮 A/B 换了题目（表格公式引擎 + CLI，同一份规范、隐藏黑盒 88 项、外加差分模糊测试）。 两组最终 B 88/88、A 87/88（差异只有一条 §5.2 语义）；这一版修的是工具侧新暴露的 4 个坑：

• mode:"patch" 的静默 no-op 被拦下：原来 items:[{patch:{id, tags:[...]}}]（少一层包装）会返回 ok:true, count:1 却一个字段都没改——最危险的"假成功"。现在直接报 args/invalid-patch， evidence 里给出收到的键与正确形状 {patch:{id, patch:{...}}}；单模块 normify_module_patch 传空补丁 同样报 args/empty-patch（只给 expect_updated_at 也不再静默通过）。
• normify_module_refresh 不再强依赖 git：repoRoot 不是 git 仓库时，以前直接 refresh/git-failed 失败（实测中 AI 只能 git init 才能激活模块）。现在改成降级：指纹照常重算、 state 照常激活，revision 保持模块原值，并给出 refresh/git-unavailable 警告与修法。
• change_open 的 acceptance 报错具体化：以前把 {zh,en} 写进 acceptance 只有一句笼统报错； 现在明确写出"第 N 条不是非空字符串（收到 …）：验收标准只接受纯字符串"，并提示双语描述写进 title/intent。
• normify_help 支持 topic:"tool:<工具名>"：tools 主题现在每个工具都带必填/可选摘要， 新主题可按需打印完整参数树（类型 / 描述 / 必填，由注册表实时生成、与运行时校验同源）。 实测里 AI 为确认 mode=patch 的嵌套形状去读了插件源码——这条主题正是为了消灭这种绕路。

v0.5.3 · 把「伴随编程实测」暴露的 4 个摩擦点修掉

这四个问题来自一次真实的 A/B 对照实验：两个 AI 用同一份规范写同一个后端，一个带插件走伴随流程、一个纯手写 （最终代码在隐藏黑盒验收上都是 42/42）。插件组多交付了 41 模块 / 110 API / 10 层的结构数据，但也踩到了下面 4 个坑：

• normify_help 支持 topic：此前它完全忽略入参，只返回同一份字段速查 —— 实测里 AI 为了拿准 change_open / layout_upsert / change_close 的参数名，只能去读插件源码（多花约 4 分钟）。 现在按主题返回：fields（默认）/ deps（箭头与 API 直连）/ renders / flow（伴随流程）/ tools（工具清单）/ policy / errors（常见诊断码与修法）/ all；传错主题会直接报错并列出可用主题，不再静默忽略。
• 项目初始化通道：新增第 31 个工具 normify_project_init —— 建 normify-<slug>/ + 默认架构规则， 可选 root 一步创建"计划态根模块"（幂等）；同时 normify_change_open 现在也会自动建项目目录 （此前报 project/no-modules，AI 只能用 module_batch {items:[],dry_run:true} 绕过去）； normify_brief 遇到不存在的模块会给出"先 init / 先建树 / 改用 task"的可执行提示。
• 批量诊断的因果链：一条 label-too-long 曾连带出 3 条 dep/target-missing（因为 L1 失败的模块会被移出批次工作集）， AI 只能去读源码才能确认根因。现在连带错误改报 dep/target-dropped / structure/parent-dropped， 在 message 与 evidence 里点明根因诊断码，并在失败响应的 root_causes 里直接列出被丢弃的模块（附 hint）。
• 「API 直连」引导：两端都声明了 API 却没写 from_api / to_api 的箭头，normify_validate 会给出聚合 warning dep/unanchored（条数 + 前 3 条示例）。这正是实验里被浪费的能力：110 条 API 声明，54 条箭头 0 条锚定 —— 不锚定，箭头就只能落在框边，钉不到 API 行上。引导≠放宽：锚错键仍然是 error。

v0.5.2 · 修掉三处会写坏数据的真实缺陷

• normify_module_upsert 的必填表不再丢失：parameters.required 恢复为 ["frontmatter"]， frontmatter 的 9 个必填字段（uid / id / parent / name / description / source / revision / updated_at / fingerprint） 也重新出现在 schema 里。此前嵌套 schema 被二次编译，必填表被整段丢掉 —— 模型看到的约束与运行时实际校验不一致。
• normify_module_move 迁移渲染数据时重写内容：id / order / groups.children / edge_hints 全部改写到新 id， 并同步维护旧父级（删掉已迁出子模块的引用）与新父级（把新 id 补进 order）。 修复前：move 完之后项目立刻被 L2 判为 layout/id-mismatch + layout/order-child 等（实测 8–9 个 error，0.5.2 后为 0）。
• 晋升为容器时不再把 API 留在容器上：叶子被晋升（显式 normify_module_promote、写子模块自动晋升、move 到叶子底下） 时，容器上残留的 apis 会被摘除，并回报 structure/api-dropped-on-promote 警告（附丢失的 API 键清单）—— 修复前项目会直接卡在 api/non-leaf。
• API 默认全展开：渲染数据字段 max_api_rows 缺省 0 = 全部展开，叶子上的 API 一行不折叠；需要收窄时显式写 1..48。
• 三处缺陷各自配了回归断言：tests/regression-0.5.2.mjs（34 项，全绿）。

v0.5.1 · 渲染器防重叠（线压线 12 → 0）

• 修复连线共线重叠：28 层合计 12 处 → 0 处。四处根因： ① 首选路由只判"不穿别人的框"，从不检查是否压到已画的线 → 改为只接受 violations === 0 的候选； ② API 锚定端口没有端口分离（同一 API 行被多条边共用） → 行内 ±5.5px 扇形分离； ③ API 端口落在上下边时被放进框内部 → 上下边退回按边均匀分离； ④ segClear 整块跳过源/目标框 → 新增"进入自身框内部"检查（内缩 2px）。
• 节点/分组间距 170 → 220，给密集层更多自由通道。

v0.5.0 · 取消模块数量上限

• 删除 MAX_DEPTH = 12 硬限制：树可以一直下钻到"单一功能单元"；需要限层时用 policy.yml 的 max-depth 规则显式声明（maxDepth 放宽到 1..64）。
• SKILL：目标深度改为"不设上限"，单批上限 40 → 200，新增"每叶 API 尽量 3–5 条"的粒度指引。

4. 截图

总览层（129 模块）	工具层（31 个工具、五族）

引擎层（API 直连箭头）	模型层（修复后的干净走线）

上面几张都是 Normify 对自身源码生成的架构图（129 模块 / 214 API / 257 箭头 / 28 层渲染数据，validate 0 error）。

5. 安装

方式 A：从压缩包安装（推荐，不依赖源码目录）

# 1) 构建发行包（或直接使用仓库 Releases 里的 tgz）
cd dsh-normify && npm install && npm run build && npm pack

# 2) 把包解到目标 profile 的 node_modules（DSHEAC AIO 6.9.x 的 profile 是 web-desktop）
#    <profile>/node_modules/@dsh-external/dsh-normify/

# 3) 编辑 <profile>/package.json：
#    dependencies       增加  "@dsh-external/dsh-normify": "file:<tgz 绝对路径>"
#    dsh.profile.bundles 增加  "@dsh-external/dsh-normify"

# 4) 重启 DSH 桌面端（工具在会话启动时快照，需新会话）

插件行的注册由 bundle 自身完成：package.json > dsh.bundle.patch: ./cordis.patch.yml， DSH 会把它插进 cordis 树，不需要手改 profile 的 cordis.patch.yml。

方式 B：dsh plugin（自动登记 bundle）

dsh plugin --profile web-desktop add <dsh-normify 目录的绝对路径>
# 或：dsh plugin --profile web-desktop add link:F:/dsh-normify

方式 C：开发模式（改源码 → 重启即生效）

把 profile 的依赖写成 link:<本仓库绝对路径>，并在 node_modules 里建立指向本仓库的 目录联接（junction）。此时插件按真实路径解析依赖，因此本仓库需要 node_modules/yaml（npm install 即可）。

⚠️ 注意：DSHEAC AIO 应用升级会按 resources/profile-seed 重播种 profile， 已安装的插件登记会被抹掉；升级后请用方式 A/B 重装一次。

验证安装

# 在 profile 目录下用裸包名导入，应打印 31 个工具 + 技能
node -e "import('@dsh-external/dsh-normify').then(m=>console.log(m.name))"
# 或在 DSH 里直接问 AI：「列出你手上的 normify 工具」

6. 快速开始

装好后，直接用自然语言指挥 AI 即可。最常用的三条：

# ① 为仓库建架构图（首次全量生成 + 渲染）
用 normify-gen 技能为 F:\my-project 建结构树并渲染架构图，粒度到单一功能单元。

# ② 先建图后编程（推荐开发姿势）
我要给 my-project 加一个「限流」模块：先 normify_brief 给我指引，建计划态模块，我实现完再 refresh 激活、change_close 收尾。

# ③ 代码改了，同步结构图
同步 my-project 的结构图（normify_sync），把受影响的模块与渲染数据更新掉，0 error 后重新 build + render。

AI 侧实际会跑：

normify_tree_list → normify_module_upsert（根 + 一级子模块）
  → normify_module_list（逐层下钻）→ normify_module_batch（批量建树，原子）
  → normify_layout_upsert（每个容器一层渲染数据）
  → normify_fingerprint（写 fingerprint 前必算）
  → normify_validate（0 error 门禁）→ normify_build → normify_render

产物（默认写在结构数据目录 normify-<slug>/ 下）：

7. 31 个工具

8. 数据结构（模块 frontmatter）

---
uid: 8c69b5a8                 # 8 位小写 hex，全项目唯一，改名/移动都不变
id: dsh-normify.engine.ids    # 路径式 id，首段=树名；深度不设上限
parent: dsh-normify.engine    # 必须等于 id 去尾段；根为 null
name: {zh: "标识与路径", en: "Identifiers & Paths"}
description:                  # 双语，各 ≤500 字符，人机共读
  zh: >
      模块 id 的文法、派生与 id ↔ 文件路径的双向映射。
  en: >
      Module id grammar, derivations and the id ↔ file-path mapping.
source:                       # 代码证据（仓库相对路径 + 可选行号）
  - {path: src/engine/ids.ts, line: 6, end_line: 34}
revision: 90df4a10…           # 生成时仓库的 40 位 git SHA
updated_at: "2026-09-12T12:00:00Z"
fingerprint: 630ac9020dba…    # source 的确定性指纹（用 normify_fingerprint 计算）
state: active                 # active | planned（计划态）| deprecated（废弃）
tags: [engine, ids]           # 可选，≤12 个
apis:                         # 仅叶子；每叶建议 3–5 条
  - protocol: rpc             # http|ws|rpc|amqp|kafka|mysql|redis|file|grpc|graphql
    path: splitId
    description: {zh: "解析 id 为段数组。", en: "Parses an id into segments."}
deps:                         # 出向箭头（只存源端）；可跨树
  - kind: call                # call|event|dataflow|reference
    to: dsh-normify.engine.model.module
    from_api: rpc:splitId     # 可选：锚定到本模块的某个 API（"API 直连"）
    to_api: rpc:Module
    label: {zh: "id 契约", en: "Id contract"}
---
（正文：给人类读者的展开介绍，可选）

文件布局：modules/<树名>/<路径段…>/index.md（容器）/ <最后一段>.md（叶子）—— 由工具自动维护形态。

9. 渲染数据（renders/，决定"这一层怎么画"）

每个容器模块一层，与模块一一对应：

{
  "schema_version": 1,
  "id": "dsh-normify.engine.model",
  "updated_at": "2026-09-12T12:00:00Z",
  "mode": "grid",              // auto | layers | groups | grid
  "max_columns": 3,            // 1..6
  "max_api_rows": 0,           // 0 = 全部展开（缺省）；1..48 = 截断到该行数
  "reading": {"zh": "本层 8 个子模块…", "en": "…"},
  "order": ["dsh-normify.engine.model.text", "…"],
  "groups": [{"id": "model", "title": {"zh": "模型与契约", "en": "Model"}, "children": ["…"]}],
  "edge_hints": [{"from": "a", "to": "b", "lane": 2, "style": "curve"}]
}

可读性配方：顺序 = 数据流、分组 = 领域边界、导语 = 阅读路径、长回边用 edge_hints 拉开车道。

10. 架构规则（policy.yml）

rules:
  - id: core-acyclic                 # 依赖图禁止成环
    type: acyclic
    severity: error
    includeCrossTree: true
  - id: layer-direction              # 层顺序 = 允许的依赖方向
    type: dependency-direction
    severity: error
    allowSameLayer: true
    layers:
      - {name: plugin, match: ["dsh-normify.plugin"]}
      - {name: tools,  match: ["dsh-normify.tools", "dsh-normify.tools.**"]}
      - {name: engine, match: ["dsh-normify.engine", "dsh-normify.engine.**"]}
  - id: naming-kebab                 # 命名约束
    type: naming
    pattern: "^[a-z][a-z0-9-]*$"
    scope: ["dsh-normify.**"]

项目创建时自动安装默认规则（无环 + 禁指向废弃模块），可随时用 normify_policy_upsert 覆盖。 深度上限是可选项：不写 max-depth 就是不限层。

11. 伴随开发：先建图后编程 / 伴随编程改图

11.1 先建图后编程（design-first）

① normify_change_open   开变更单（title / intent / modules / acceptance）
② normify_brief          拿指引：目标模块与契约、影响面（谁依赖我）、规则约束、建议模块、验收清单
③ normify_check          预检：拟建模块与依赖是否违反核心约束或 policy
④ normify_module_batch   建「计划态」模块（state=planned, fingerprint=pending, 源码可以先不存在）
                          同一轮用 normify_layout_upsert 写该层渲染数据
⑤ 【人/AI 写代码】        实现对应模块
⑥ normify_module_refresh 重算指纹与 revision，activate:true → planned 自动转 active
⑦ normify_change_close   0 error 强制收尾：刷新 → 校验 → 编译 → 标记 verified + revision.after

• 计划态下 normify_validate 0 error（源码未落地也合法，只记 warning）；
• 源码没落地就 activate / close 会被拒绝（禁止"假激活"）；
• 变更单存在结构目录内（changes/<id>.json），随工程一起回档。

11.2 伴随编程改图（companion update）

① 改代码（提交与否都行）
② normify_sync            检出：changed_files / affected / drift_fingerprints / layouts_to_review
                          新文件还会给出「建议模块」（含 id 与目标路径）
③ normify_module_patch    跟随代码更新模块：补 API、改介绍、重算 fingerprint 与 revision
④ normify_validate        0 error
⑤ normify_change_close    收尾并重建产物（tree.json 会反映本次变更统计）

实测（本项目自身）：改完 src/engine/layout.ts + CHANGELOG.md 后，sync 报出 7 个 evidence/fingerprint-drift， refresh 后回到 0 error —— 这正是"图与码不脱节"的日常形态。

12. 渲染器细节（v3 / 0.5.2）

• 走线：连线只走"自由通道"（相邻列/行之间的空隙），节点框保持 ≥16px 净空；全局车道坐标注册表保证 同一坐标不分配给两条边；候选路径做框体/组框碰撞检测，兜底用"自由行 × 自由列"总线。
• 防重叠（0.5.1）：路由首选只接受 violations === 0 的候选（不穿框 / 不压已画线 / 不横穿自身框 / 端口法向正确）；API 锚定端口按到达顺序在 API 行内 ±5.5px 扇形分离。
• 全展开（0.5.2）：max_api_rows 缺省 0 → 每个叶子的 API 全部展开，箭头锚点与 API 行一一对应（不再 +N 折叠）。
• API 直连：叶子框内展示 max_api_rows 行 API（0 = 全部，也是缺省），箭头锚定到具体 API 行的端口。
• 跨层聚合：跨层依赖默认聚合为虚线 ×N（?agg=1 或工具栏开启，悬停看明细）。
• viewBox 自适应：由全部几何包围盒动态计算（线不出视口）；缩放 / 适配 / 100%。
• 几何自检：check-geometry.mjs 逐层断言五项指标（越界 / 贴边 / 穿框 / 贴组框 / 线压线）。 本项目自身 129 模块 / 28 层：线压线 0 处，27/28 层五项全 0。

13. 工程与测试

npm install          # 安装 devDependencies（typescript / @types/node / cordis / schemastery / cosmokit）
npm run build        # src/ → lib/（tsc；两条路径：本地 vendor-ts 或 npm）
npm run typecheck    # tsc --noEmit
npm test             # engine-e2e.mjs + companion-e2e.mjs（不依赖 DSH 的 node 端到端）
node ci-contract-check.cjs   # 契约检查：bundle 声明 + 恰好 31 个工具 + provider 安全命名

14. 兼容性与排错

常见问题

• 装了但工具不出现 → 工具列表在会话启动时快照：请新开一个会话（或重启桌面端）。
• 升级 AIO 后插件消失 → 应用升级会按 resources/profile-seed 重播种 profile，重装一次即可。
• Cannot find package 'yaml' → link: 安装时按真实路径解析依赖，请在本仓库执行一次 npm install。
• evidence/fingerprint-drift → 源码变了而结构数据没跟上：normify_sync 看漂移清单，normify_module_refresh 重算指纹。
• structure/leaf-too-coarse → 不是错，是提示：该叶子还能继续拆（推荐拆到"单一功能单元"）。

15. 安全与隐私

• 无遥测、无网络请求：结构数据与渲染产物全部在本地生成，normify.html 不加载任何外部资源。
• 不做凭据处理：插件不读取、不写入任何 token / 私钥 / password；.gitignore 已排除 .env*、*.pem、 *.credentials.yaml 等；仓库内不存在任何凭据，也请不要提交。
• 只读仓库：生成器遵守"只读源码"铁律 —— 结构数据只写入 normify-<slug>/，绝不修改被分析的仓库。
• source 字段只记录仓库相对路径与行号，不会把源码内容复制进结构数据。

16. 文档索引

许可证

MIT © yan-mc

_{Normify —— 让架构图跟着代码一起生长。}