dsh-model-everything 0.0.0-stage → 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (130) hide show
  1. package/LICENSE +21 -0
  2. package/README.en-US.md +319 -0
  3. package/README.md +319 -3
  4. package/cordis.patch.yml +20 -0
  5. package/examples/README.md +48 -0
  6. package/examples/control-dispatcher.json +113 -0
  7. package/examples/control-dispatcher.overbudget.json +113 -0
  8. package/examples/ecommerce-data-model.json +185 -0
  9. package/examples/order-state-machine.after.json +116 -0
  10. package/examples/order-state-machine.before.json +101 -0
  11. package/examples/user-migration.after.json +29 -0
  12. package/examples/user-migration.before.json +29 -0
  13. package/gate/locale/en.json +6 -0
  14. package/gate/locale/zh.json +6 -0
  15. package/gate/package.json +5 -0
  16. package/lib/baseline.js +249 -0
  17. package/lib/compose-tool.js +76 -0
  18. package/lib/concurrency-tool.js +40 -0
  19. package/lib/concurrency.js +206 -0
  20. package/lib/data-engine.js +1141 -0
  21. package/lib/data-tool.js +79 -0
  22. package/lib/design-engine.js +1149 -0
  23. package/lib/design-tool.js +55 -0
  24. package/lib/engine.js +4343 -0
  25. package/lib/export-tool.js +78 -0
  26. package/lib/exporters.js +434 -0
  27. package/lib/gate.js +274 -0
  28. package/lib/granularity.js +237 -0
  29. package/lib/index.js +237 -0
  30. package/lib/json-value.js +18 -0
  31. package/lib/option-shape.js +62 -0
  32. package/lib/report-diff-tool.js +63 -0
  33. package/lib/report-view.js +408 -0
  34. package/lib/structure-tool.js +91 -0
  35. package/lib/structure.js +711 -0
  36. package/lib/tool.js +85 -0
  37. package/lib/types/baseline.d.ts +65 -0
  38. package/lib/types/compose-tool.d.ts +7 -0
  39. package/lib/types/concurrency-tool.d.ts +8 -0
  40. package/lib/types/concurrency.d.ts +37 -0
  41. package/lib/types/data-engine.d.ts +211 -0
  42. package/lib/types/data-tool.d.ts +10 -0
  43. package/lib/types/design-engine.d.ts +215 -0
  44. package/lib/types/design-tool.d.ts +11 -0
  45. package/lib/types/engine.d.ts +494 -0
  46. package/lib/types/export-tool.d.ts +7 -0
  47. package/lib/types/exporters.d.ts +37 -0
  48. package/lib/types/gate.d.ts +91 -0
  49. package/lib/types/granularity.d.ts +106 -0
  50. package/lib/types/index.d.ts +45 -0
  51. package/lib/types/json-value.d.ts +21 -0
  52. package/lib/types/option-shape.d.ts +22 -0
  53. package/lib/types/report-diff-tool.d.ts +8 -0
  54. package/lib/types/report-view.d.ts +43 -0
  55. package/lib/types/structure-tool.d.ts +10 -0
  56. package/lib/types/structure.d.ts +152 -0
  57. package/lib/types/tool.d.ts +11 -0
  58. package/lib/types/uml-communication.d.ts +109 -0
  59. package/lib/types/uml-composite.d.ts +107 -0
  60. package/lib/types/uml-interaction-overview.d.ts +91 -0
  61. package/lib/types/uml-profile.d.ts +112 -0
  62. package/lib/types/uml-structure.d.ts +53 -0
  63. package/lib/types/uml-syntax.d.ts +296 -0
  64. package/lib/types/uml-timing.d.ts +152 -0
  65. package/lib/types/uml-tool.d.ts +12 -0
  66. package/lib/types/uml-usecase.d.ts +58 -0
  67. package/lib/types/uml.d.ts +303 -0
  68. package/lib/uml-communication.js +353 -0
  69. package/lib/uml-composite.js +442 -0
  70. package/lib/uml-interaction-overview.js +277 -0
  71. package/lib/uml-profile.js +373 -0
  72. package/lib/uml-structure.js +306 -0
  73. package/lib/uml-syntax.js +545 -0
  74. package/lib/uml-timing.js +974 -0
  75. package/lib/uml-tool.js +213 -0
  76. package/lib/uml-usecase.js +532 -0
  77. package/lib/uml.js +2110 -0
  78. package/locale/en.json +6 -0
  79. package/locale/zh.json +6 -0
  80. package/package.json +124 -6
  81. package/skills/model-everything/SKILL.md +482 -0
  82. package/skills/model-everything/references/dsh-model-schema.md +437 -0
  83. package/skills/model-everything/references/gap-routing-guide.md +42 -0
  84. package/skills/model-everything/references/hash-spec.md +152 -0
  85. package/skills/model-everything/references/logic-verification-guide.md +422 -0
  86. package/skills/model-everything-datamodel/SKILL.md +130 -0
  87. package/skills/model-everything-datamodel/references/data-model-guide.md +84 -0
  88. package/skills/model-everything-datamodel/references/data-model-schema.md +128 -0
  89. package/skills/model-everything-design/SKILL.md +115 -0
  90. package/skills/model-everything-interleaving/SKILL.md +63 -0
  91. package/skills/model-everything-interleaving/SKILL.zh-CN.md +60 -0
  92. package/skills/model-everything-interleaving/references/concurrency-risk-guide.md +63 -0
  93. package/skills/model-everything-report-reading/SKILL.md +137 -0
  94. package/skills/model-everything-report-reading/references/reading-a-report.md +166 -0
  95. package/skills/model-everything-report-reading/references/reading-a-report.mmd +59 -0
  96. package/skills/model-everything-structure/SKILL.md +96 -0
  97. package/skills/model-everything-structure/references/structure-review-guide.md +201 -0
  98. package/skills/model-everything-uml/SKILL.md +60 -0
  99. package/skills/model-everything-uml/references/uml-modeling-guide.md +551 -0
  100. package/src/baseline.ts +288 -0
  101. package/src/compose-tool.ts +78 -0
  102. package/src/concurrency-tool.ts +44 -0
  103. package/src/concurrency.ts +254 -0
  104. package/src/data-engine.ts +1208 -0
  105. package/src/data-tool.ts +83 -0
  106. package/src/design-engine.ts +1263 -0
  107. package/src/design-tool.ts +60 -0
  108. package/src/engine.ts +4564 -0
  109. package/src/export-tool.ts +81 -0
  110. package/src/exporters.ts +399 -0
  111. package/src/gate.ts +330 -0
  112. package/src/granularity.ts +312 -0
  113. package/src/index.ts +289 -0
  114. package/src/json-value.ts +20 -0
  115. package/src/option-shape.ts +64 -0
  116. package/src/report-diff-tool.ts +67 -0
  117. package/src/report-view.ts +451 -0
  118. package/src/structure-tool.ts +93 -0
  119. package/src/structure.ts +786 -0
  120. package/src/tool.ts +94 -0
  121. package/src/uml-communication.ts +428 -0
  122. package/src/uml-composite.ts +520 -0
  123. package/src/uml-interaction-overview.ts +321 -0
  124. package/src/uml-profile.ts +439 -0
  125. package/src/uml-structure.ts +317 -0
  126. package/src/uml-syntax.ts +764 -0
  127. package/src/uml-timing.ts +1106 -0
  128. package/src/uml-tool.ts +230 -0
  129. package/src/uml-usecase.ts +566 -0
  130. package/src/uml.ts +2139 -0
package/README.md CHANGED
@@ -1,3 +1,319 @@
1
- # Temporary Holding Version
2
-
3
- This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
1
+ # 设计与代码的建模/自动化审查(dsh-model-everything)
2
+
3
+ <p align="center"><a href="README.en-US.md">English</a> · <strong>中文</strong></p>
4
+
5
+ 把设计与代码里的断言抽象成模型,交给引擎跑一遍:结论带出处与哈希,能复算、能比对。让结论来自一次运行,而不是一次通盘推理:把「想清楚」变成「跑一遍」。
6
+
7
+ DeepSeek Harness 原生插件。把设计与代码里**关于行为的断言**变成可运行、可审查、可导出的模型:
8
+
9
+ - **核验断言**:逐条对着源码检查,引用到 `file:line`。
10
+ - **跑模型**:状态机、协议、多机协作、数据模型先建成可执行模型,再交给引擎跑。
11
+ - **审图**:UML 图按模型读、按模型审,并与模型对照。
12
+ - **对照重构**:重构前后各建一份模型,两份报告摆一起比。
13
+ - **留痕**:结论固化成带哈希的报告,可复算、可比对、可导出。
14
+
15
+ ## 能力范围
16
+
17
+ | 域 | 做什么 |
18
+ |---|---|
19
+ | 事实核验 | 把一份设计/规格/评审意见里的可验证断言列出来,逐条对着代码核验并给出出处。核不了的直接说明 |
20
+ | 行为验证 | 状态机与协议:结构检查、对抗性探测、预算与时限、before/after 回归。多机组合查死锁,以及永不发生的会合(握手事件) |
21
+ | 图 | UML 2.5 各图族的渲染、解析与建模审查(含 render→parse 往返一致性对照),覆盖 Mermaid 与 PlantUML 两种记号 |
22
+ | 结构 | 组件/包/类/部署图按依赖图审计:孤立节点、悬空引用、环、矩阵与分层违规、缺失的必需边 |
23
+ | 数据 | 数据模型与迁移:结构、迁移覆盖、拷贝一致性、回滚对称、前后数据回归 |
24
+ | 并发 / 同步 / 异步 | 挖掘"工作怎么被执行"的断言(线程安全、锁、中断、async/await、事件循环…)并路由到能判定它的工具;它自己不证明 |
25
+ | 导出 | 已验证模型导出为 UPPAAL / TLA+ / PRISM / SPIN 的输入 |
26
+ | 报告 | 报告正文渲染、基线比对(`report_diff`)、哈希规范 |
27
+
28
+ ## 典型用法
29
+
30
+ ### 重构 harness
31
+
32
+ 重构可以改实现,不能改行为。这个判断交给引擎,不必通读 diff:
33
+
34
+ 1. **重构前**:从当前代码抽出 BEFORE 模型(`uml_parse` 读已有的图,或按 schema 手写)。
35
+ 2. **重构**。
36
+ 3. **重构后**:抽出 AFTER 模型。
37
+ 4. **回归**:`model_verify` 带 `beforeModel` 与 `stateMapping` 跑前后回归:行为是否保持、不变式是否连续、状态映射是否自洽。数据侧用 `model_datamodel_verify` 的 `beforeModel` / `fieldMapping` / `migrationMappings` 做同一件事的**数据版**。
38
+ 5. **判定与留痕**:`report_diff` 拿基线报告比对。新增的 error 发现,就是这次重构不接受的理由。报告里的哈希让结论可复算。
39
+
40
+ 它比较的是**你给的两份模型**,不是两份代码。每份模型是否忠实于对应代码,由第 1、3 步负责,它不代替你做。它也不读 diff、不改代码、不跑你的测试。它回答的是"行为还一样吗",不是"重构得好不好"。
41
+
42
+ ### 代码流程审查
43
+
44
+ 先把分支逻辑画成流程,再看这张图到底说了什么:
45
+
46
+ 1. **抽流程**:把函数或服务里的分支写成 `LogicModelV1`,或者手画一张 `stateDiagram-v2` / PlantUML 图。
47
+ 2. **读回模型**:手画的图交给 `uml_parse` 转成模型。读不动的行会变成警告,不会悄悄跳过。
48
+ 3. **审查**:`uml_review` 报结构缺陷——不可达状态、死端、分支有歧义或没穷尽、自环没有出口、孤立节点、环——以及文档缺口。
49
+ 4. **落回源码**:每条发现都回到代码核验。图画对了,不等于代码写对了。
50
+
51
+ 它审的是你给的那张图和那份模型。图与代码是否一致,由第 1 步的抽取负责。
52
+
53
+ ### 状态机审查
54
+
55
+ 把状态机建成可执行模型,让引擎去跑,而不是通读代码判断它会不会卡死:
56
+
57
+ 1. **建模型**:手画的 `stateDiagram-v2` 或 PlantUML 状态图交给 `uml_parse`;也可以直接按 schema 写 `LogicModelV1`。
58
+ 2. **跑检查**:`model_verify` 找的是不可达状态、吸收环、被静默忽略的事件、没有恢复路径的资源申请、预算超限,以及无法满足的时限。每一项都作为一个**带码**的发现报出,而码的前缀说明它属于哪一族。
59
+ 3. **写清"永远/绝不"**:把这类断言写进 `invariants`,引擎会在全部可达状态上搜反例,并给出它找到的最短路径。
60
+ 4. **落回源码**:报告里的 error 发现逐条回到代码。
61
+
62
+ 并发断言分两半:**两个模型都碰同一个共享位置**这一类,由我们自己的 `model_compose_verify` 判(声明 `shared` 与 `accesses` 之后的 C3/C4/C5,包括丢更新);源码级数据竞争、中断延迟、阻塞调用与漏掉的 `await` 仍路由到 TSan/Helgrind/CBMC/TLA+。硬实时语义(deadline、period)不在它的范围内。
63
+
64
+ ### 审计一张依赖图
65
+
66
+ 组件图是关于「哪些模块可以依赖哪些」的断言。把它当图读,再问那些边是否被允许:
67
+
68
+ 1. **给图**:PlantUML 的组件/包/类/部署图源码,或 Mermaid 类图。`uml_structure_verify` 把它解析成节点与边。
69
+ 2. **说清什么被允许**(如果有规则):一个含 `layers` 与 `rules` 的矩阵,每条规则点名一个 `source` 并给 `allow` / `deny` / `require`,再用 `default` 管其余。没有矩阵时,它只报结构缺陷。
70
+ 3. **读发现**:孤立节点、从未声明过的端点、带最短路径的环、越过层的边、缺失的必需边,以及——一个节点都没声明时——**这份输入没有任何可审的东西**。
71
+ 4. **换一种图就换个工具**:如果这张图是状态图或活动图,那是 `uml_review`,不是它。
72
+
73
+ 它审的是**图**,不是代码。一张自洽的图仍可能画错了系统,所以要和源码侧扫描配对。手画的图报「标签漂移」时,`uml_explain_labels` 会打印该记号下解析器接受的标签写法。
74
+
75
+ ### 让设计对自己作出的声明负责
76
+
77
+ 设计会对自己作出断言:这一层在那层之上、这个组件拥有那条依赖、这个接口比它的调用方窄。`model_design_review` 判定设计是否守住了这些承诺:
78
+
79
+ 1. **把设计写成模型**:架构(节点与边),加上它声明的——分层、边界、允许与必需的边、带职责的类型、操作、转移、父类型。
80
+ 2. **跑它**:`model_design_review` 报出设计与自相矛盾的地方,并**另外**报出它图的形状——环与打断环所需的最少边、承重元素、层级、扇入扇出。
81
+ 3. **读那三个列表**:`violations` 决定判定;`signals` 值得一看但不使任何东西失败;`facts` 是**测量**,不是发现。`checksSkipped` 说明哪些原则因为**没声明任何可对照的东西**而没有检查。
82
+
83
+ **它从不按外部标准评判设计。** 它报的是:设计**与它自己声明的某件事**矛盾,或关于它的图的一个结构事实。问「这个设计好不好」是评审者的问题;这个工具回答的是另一个:**它就自己的说法而言,站得住吗**。
84
+
85
+ ### 两台必须互相配合的机器
86
+
87
+ 一台机器**不会因为另一台**而死锁。当两个组件握手时,真正有意思的失败在**组合**里:
88
+
89
+ 1. **各自建模**,然后一起给:`model_compose_verify` 收一个模型数组。
90
+ 2. **点名共享事件**:如果一个握手只有在双方都就绪时才合法,把它写进 `rendezvous`。没写进去的事件只推进一台机器,所以等握手的机器可以先走任意多步自己的路。
91
+ 3. **读 C1 与 C2**:一个可达节点上没有任何机器能前进、且有机器不是终止态(C1),以及一个**永远不会触发**的会合(C2)。两者都逐机给出理由,C1 还给最短反例。
92
+
93
+ 模型里**没有速率比,也没有公平性约束**。单台机器自己的问题——不可达状态、不变式、成本对预算——用 `model_verify`。
94
+
95
+ ### 并发声明:挖掘并路由
96
+
97
+ 「线程安全」「lock-free」「ISR 安全」都是需要某个能判定它们的工具的断言,而第一步是**把它们找出来**:
98
+
99
+ 1. **扫文本**:`model_interleaving_scan` 收文档、计划或笔记,报出风险点——那条声明、共享状态、中断、临界区,以及异步的那些(`async`、`await`、`promise`、事件循环、回调)。每条发现都带 `family`(threads / synchronization / async / interrupts / shared-state),绝对式断言按 error 报。
100
+ 2. **看每条绝对声明欠着什么**:「不可能有数据竞争」这类声明会被报为 error,要求**专门的**验证,且每条发现都点名能判定它的分析——竞争用 TSan 或 Helgrind,有界证明用 CBMC,协议用 TLA+,中断用 RTOS 感知的分析。
101
+ 3. **去做那个分析**:本插件不运行它,也不对并发安全作任何证明。
102
+
103
+ 它读的是**文本**。它看不见你的线程,而**一次干净的扫描不是健康证明**——它的含义是没找到声明,这是另一个命题。
104
+
105
+ ### 一次迁移:前后两份模型
106
+
107
+ 迁移是两份模型,加一个「数据活下来了」的断言。把两份都给出去,这个断言就变成可核查的:
108
+
109
+ 1. **两份模型**:改动前的 schema 与改动后的 schema,各自是含实体、字段、键与关系的数据模型。
110
+ 2. **说清字段怎么走**:`fieldMapping` 从旧路径到新路径,加上 `migrationMappings`——用于来源不是它自己旧名字的字段。
111
+ 3. **跑比对**:`model_datamodel_verify` 带 `beforeModel`,检查迁移覆盖、拷贝一致性、回滚对称,以及前后数据回归。
112
+ 4. **读那条警告**:新 schema 里声明为 `required`、却没有任何东西供给它的字段,会报 `DS2_REQUIRED_FIELD_UNSOURCED`。它是 **warning**,所以判定停在 `pass_with_findings`——**这是一个要做的决定,不是引擎可以替你宣布的失败**。
113
+
114
+ 它比较的是**你给的两份模型**。任一份是否忠实于它所描述的数据库,是抽取那一步的事,这个工具不做。
115
+
116
+ ### 图的导入与导出:设计冻结与长期迭代
117
+
118
+ 这里存的是**源文件**,不是截图:`uml_render` 写出 Mermaid / PlantUML 源,`uml_parse` 把源读回模型。一份图因此能当两种东西用:
119
+
120
+ - **设计冻结的留档**:把图源、模型和那一次的验证报告一起提交进仓库,作为某个时间点的设计记录。模型里可以放 `_` 前缀的元数据(单据号、日期、负责人、抽取时留下的保留意见),这些键不参与哈希,补档案信息不会改变结论的身份。
121
+ - **长期迭代的参考**:下一次改动时重新抽出模型、重跑验证,再用 `report_diff` 与冻结的那份报告比对。新增的 error 是这次改动引入的,消失的说明旧问题已经解决;哈希让"还是不是同一份模型"可判定,不必肉眼比图。
122
+
123
+ 需要交给外部检查器时,同一份模型可以用 `model_export` 导出成 UPPAAL / TLA+ / PRISM / SPIN 的原生输入。
124
+
125
+ 界线:它保存并比对的是**模型与图的源文件**,渲染出来的图片只是副产品。图变了模型没变、或模型变了图没变,都会在下一次解析或比对时暴露。
126
+
127
+ ## 工具
128
+
129
+ | 工具 | 做什么 |
130
+ |---|---|
131
+ | `uml_render` | 模型 → 图源(Mermaid / PlantUML),可指定图族。记号表达不了的视图会被拒绝,并说明理由 |
132
+ | `uml_parse` | 图源 → 该图族的模型;不属于状态机/流程的族会按名拒绝,而不是硬当作状态机解析 |
133
+ | `uml_review` | 审查建模:结构缺陷、文档缺口、render↔parse 往返一致性;给模型、给图,或两者对照 |
134
+ | `uml_explain_labels` | 打印解析器接受的标签与注释契约,不需要图 |
135
+ | `model_verify` | 状态机 / 协议的可执行验证(结构检查、对抗性探测、预算、时限、前后回归) |
136
+ | `model_compose_verify` | 两台及以上机器的组合检查(死锁、永不发生的会合;声明了共享位置后还有无序写 C4 与非原子更新 C5) |
137
+ | `model_datamodel_verify` | 数据模型与迁移验证 |
138
+ | `model_interleaving_scan` | 并发 / 同步 / 异步声明的挖掘与路由 |
139
+ | `model_export` | 导出到外部检查器(UPPAAL / TLA+ / PRISM / SPIN) |
140
+ | `uml_structure_verify` | 依赖图审计(含依赖矩阵与多层级细化) |
141
+ | `model_design_review` | 设计审阅:依赖图形状 + 设计自身声明的契约(分层、职责边界、可替换性、接口宽度) |
142
+ | `report_diff` | 两份报告比对:新增/消失/变化的发现 |
143
+
144
+ ## 怎么读报告
145
+
146
+ 工具的产出是一份报告,结论只在 `verdict` 里:**看 `verdict`,不看 `ok`**。`ok` 在各族的含义不同——多数族在评审失败时仍是 `true`,组合族在出现 error 级发现时是 `false`——所以它不能当判定读;把它当判定读,会得出与报告相反的结论。
147
+
148
+ | 字段 | 说明 |
149
+ |---|---|
150
+ | `verdict` | 判定:`pass`、`pass_with_findings`、`fail` |
151
+ | `verdictReason` | 一句话说明为什么是这个判定 |
152
+ | `hashes` | `hashSpec` 与 `modelHash`;前后回归另带 `beforeModelHash`、`afterModelHash`。同一份模型永远得到同一个哈希 |
153
+ | `nextSteps` | 引擎建议的下一步 |
154
+ | `schema` | 报告的版本化契约,例如 `model-everything/verify/v1`。要按字段分支,就分支在它上面 |
155
+ | `truncated` | 搜索撞到上限就停了。**截断不等于通过**,是没结论;某个性质没判定出来时,报告里会出现 `_UNDECIDED` |
156
+
157
+ 默认返回正文。要完整 JSON,传 `reportView: "full"`。
158
+
159
+ `ok` 为 `false` 时判定也是 `fail`,但含义不同:工具根本没跑。原因写在 `errorCode` 里——输入不合法、图族不支持,或声明的 `intent` 服务不了。这类拒绝的 `verdictReason` 以 `the tool did not run:` 开头。
160
+
161
+ 报告怎么读,有一份成体系的说明:[`skills/model-everything-report-reading/`](skills/model-everything-report-reading/) 讲阅读顺序(先看跑没跑、再看判了什么、最后看该做什么)、发现分别放在哪一层、以及两处最容易读反的地方。结构由一个**从真实报告生成的思维导图**给出:[`docs/report-reading/mindmap.mmd`](docs/report-reading/mindmap.mmd),`tests/report-reading` 会在图与引擎不一致时失败。
162
+
163
+ `uml_render`、`uml_parse`、`uml_review` 另收一个 `intent`,用来说明这份产物要做什么:给人看(`present`)、要被验证引擎读回(`verify`)、还是要证明渲染与模型一致(`fidelity`)。服务不了这个用途的视图会被直接拒绝,而不是勉强画出来。
164
+
165
+ ## 示例
166
+
167
+ `examples/` 里是可以直接跑的样本模型,配 [`examples/README.md`](examples/README.md) 说明各自的看点和预期结果。它们是文档,不是测试夹具——各测试套件读自己的 `tests/<套件>/fixtures/`:
168
+
169
+ - `examples/order-state-machine.before.json` 与 `examples/order-state-machine.after.json`:订单流程的前后两份模型,用来跑前后回归。
170
+ - `examples/control-dispatcher.json`:带预算与锁配对的分发状态机,预期零错误。
171
+ - `examples/control-dispatcher.overbudget.json`:同一个机器换上更慢的看门狗处理,预期报出一条 `A12_BUDGET_OVER`,并给出最短的超预算路径。
172
+ - `examples/ecommerce-data-model.json`,以及 `examples/user-migration.before.json` 与 `examples/user-migration.after.json`:数据模型,和迁移的前后两份。
173
+
174
+ ```bash
175
+ model_verify model=examples/control-dispatcher.json
176
+ ```
177
+
178
+ ## 技能
179
+
180
+ 技能按域拆分,讲的是怎么用、按什么判定:
181
+
182
+ | 技能 | 覆盖 |
183
+ |---|---|
184
+ | `model-everything` | 入口:断言清单、核验纪律、深度分级、到各域技能的路由 |
185
+ | `model-everything-uml` | UML 图:选哪种视图、标签约定、审查码、往返一致性检查的边界 |
186
+ | `model-everything-structure` | 架构与依赖:矩阵怎么写、各条结构检查意味着什么 |
187
+ | `model-everything-datamodel` | 数据模型与迁移:不变式(任何时刻都必须成立的约束)、迁移覆盖、回滚对称 |
188
+ | `model-everything-design` | 设计自洽:分层是否成立、职责与依赖是否匹配、子类型能否替父类型、接口是否宽于调用方 |
189
+ | `model-everything-interleaving` | 并发、同步与异步声明:哪些能证明、用哪个工具证明、哪些只有运行时能看见 |
190
+ | `model-everything-report-reading` | 读报告:阅读顺序、发现放在哪一层、容易读反的两处 |
191
+
192
+ 技能描述本身就是路由依据,而它们能写的长度有硬上限(目录行**截断在 500 字符**,之后的部分模型看不到)。谁负责哪个问题、每行必须携带什么,由一张生成的图记录:[`docs/routing-map.md`](docs/routing-map.md),生成器是 `docs/tools/generate-routing-map.mjs`;`tests/routing-map` 会在图与目录不一致时失败。
193
+
194
+ ## 安装(dsh)
195
+
196
+ 本插件以 cordis bundle 形式提供,声明在仓库根 `package.json` 的 `dsh.bundle` 与 `cordis.patch.yml`。
197
+
198
+ ```bash
199
+ # 从源码目录安装(开发中)
200
+ dsh plugin --profile <profile> add "file:$PWD"
201
+ # 从 npm 安装(发布版)
202
+ dsh plugin --profile <profile> add dsh-model-everything
203
+ # 未全局安装 dsh 时
204
+ npx -p @deepseek-ai/dsh dsh plugin --profile <profile> add dsh-model-everything
205
+ ```
206
+
207
+ 装完重启该 profile,`dsh --profile <profile> --dump-config` 里应能看到本插件的行。卸载同样走插件管理器,从目标 profile 移除。
208
+
209
+ 技能走 DSH 标准的 filesystem skill provider 注册,工具挂在 `ctx.tools` 上。另有一条模型可见的状态目录条目,可查注册状态与引擎接受的 schema 版本。
210
+
211
+ ### 两个组件
212
+
213
+ | 组件 | 行 id | 做什么 | 默认 |
214
+ |---|---|---|---|
215
+ | `dsh-model-everything` | `dsh-model-everything` | 全部工具与技能 | 开 |
216
+ | 提示词注入增强 | `dsh-model-everything-gate` | 会话第一条模型步注入一条路由提示 | 开 |
217
+
218
+ **提示词注入增强**是第二个组件,单独开关。它补的是路由的短板:路由靠技能描述文字,而目录行截断在 500 字符;更要紧的是,一次会话如果压根没决定加载技能,就没有任何东西把它路由过去。
219
+
220
+ 它在每个会话注入一条消息(约 3.2k 字符),内容四块:不确定该查哪个时先加载哪个技能、每个技能管什么、每个工具做什么以及**它不证明什么**、以及怎么读一份报告(`verdict` 而不是 `ok`,`skip` 不是 `pass`)。**那条"先加载技能、别凭记忆回答"的规则在开头说一次、结尾换个说法再说一次**——这是量出来的:只说一次时,那种"觉得自己会答"的请求(迁移)既没加载技能也没用工具;首尾各说一次之后它补上了,而对照任务没有被过度触发。
221
+
222
+ 它的形状借了同一个 harness 里另一个插件往系统提示注入的那一节的三招(那套做法在本环境里已有先例):
223
+
224
+ - **只广播装得上的东西**:技能表按 `skills/` 目录里真实存在的技能渲染,所以表里不会出现一个解析不到的技能名;新加技能若还没写行,会退回"see its catalog line",**可以不全,但不会指错**。
225
+ - **选择表而不是一句话清单**:`| 这个请求 | 这个技能 |` 两列,路由本来就是在近义项之间排序,表格比散文更像一道选择。
226
+ - **反降级规则**:工具拒绝时读 `errorCode` 改输入再试;工具没装就明说并退回通用方法——**没有任何东西跑过的检查不是通过的检查**。
227
+
228
+ 它怎么工作,四句话:
229
+
230
+ - **注入点**:`agent/pre-step`,把消息追加到该会话**第一个**模型步的决策里,不是 session-start——后者落进 inbox,可能被空会话的 preset 切换清掉;
231
+ - **只注入一次**:消息带自己的 producer source kind,每一步都按会话历史查一次,见到就不再注入;被清掉的话会在下一个能跑的步重新出现;
232
+ - **开关**:`enabled` 是 live 字段,插件页翻开关对运行中的 host 立刻生效;`gateContent` 不是 live(一千多字的散文不该进表单),要改写在 profile 的 `cordis.patch.yml` 里;`extraGuidance` 是留给部署自己加一句的追加槽;
233
+ - **它只路由**:不检查任何东西,也不会让技能自己加载。
234
+
235
+ **开关与默认**:默认开。这个默认值是量出来的——它补上的是插件唯一接不住的那类请求,而对照任务没有被过度触发。代价是每个会话约 3.2k 字符;要关掉就改 `cordis.patch.yml`(见下)或翻插件页的开关。想做对照(同一个请求,关一次开一次)也用它。
236
+
237
+ `gateContent` 可以整段替换,用来试别的措辞;`tests/gate` 仍要求它点名每个已发布的技能。
238
+
239
+ ## 配置
240
+
241
+ 注入组件(默认开)有三个键:
242
+
243
+ | 键 | 类型 | 默认值 | 说明 |
244
+ |---|---|---|---|
245
+ | `enabled` | boolean | `true` | 是否注入。live 字段:插件页翻开关对运行中的 host 立刻生效,不用重启。 |
246
+ | `gateContent` | string | 内置文本 | 注入的全文。替换它等于自己写路由规则;`tests/gate` 仍会要求它点名每个已发布的技能。 |
247
+ | `extraGuidance` | string | `""` | 追加在消息最后的一段话,留给部署写自己的规则。 |
248
+
249
+ 主行只有一个 `interaction`(提议调用工具时怎么处置,默认 `follow-approval`);关掉主行是关掉那一行本身,不是改配置。
250
+
251
+ 按 row id 写进 profile 的 `cordis.patch.yml`:
252
+
253
+ ```yaml
254
+ - insert:
255
+ - id: dsh-model-everything-gate
256
+ name: 'dsh-model-everything/gate'
257
+ config:
258
+ enabled: false # 关掉注入
259
+ ```
260
+
261
+ ## 边界
262
+
263
+ - **不拥有你的代码。** 只读必要的文件,给出带出处的结论。结论对不对,以源码为准。
264
+ - **并发:一半路由,一半判定。** `model_interleaving_scan` 挖出声明并按 family 路由(线程→TSan/Helgrind/CBMC/TLA+,中断→RTOS 感知分析,异步→TLA+/UPPAAL 加运行时检查)。**但共享位置不再只是路由**:把 `shared` 与 `accesses` 交给 `model_compose_verify`,它会判定无序写(C4)与非原子更新/丢更新(C5)——那是一个能在模型上给出最短路见证的决定,不是某个检查的名字。源码级竞争、阻塞调用、漏 `await` 与锁是否跨整个操作持有,仍在路由的另一半。
265
+ - **图的审查不等于代码审查。** 图与它声称的模型一致,只说明图画对了。代码是不是这样,还得对着源码核验。
266
+
267
+ ## 环境要求
268
+
269
+ - 逐版本的安装 / 挂载 / 启动 / 卸载证据在 [DSH-COMPATIBILITY.md](DSH-COMPATIBILITY.md)。
270
+ - DeepSeek Harness:准入看 `package.json` 的 `peerDependencies`——插件管理器按它决定装不装得下,`dsh.compatibility.dshReleases` 只是记录实测结论。逐版本兼容性是**实测项**,没实测过的版本一律标 `unknown`。
271
+ - Node.js:`>=20`。
272
+ - 无 Python 依赖,无网络调用。
273
+
274
+ ## 权限与数据
275
+
276
+ - 运行时只读包内的 `skills/` 目录(用于注册技能),不读凭据,也不联网。
277
+ - 工具只处理你传进来的模型、图与文件路径。报告里只有它算出的结论与哈希。
278
+ - 导出到外部检查器(UPPAAL / TLA+ / PRISM / SPIN)时只写你指定的文件。
279
+
280
+ ## 故障排查
281
+
282
+ - **技能不可见**:确认 DSH 版本支持 `ctx.skills` 与 Agent Skills 发现,并在安装后重启 profile。
283
+ - **工具不在**:先查 `enabled`(可能是 `false`),再看插件管理器是否真的装上了(`--dump-config` 里有没有本插件的行)。
284
+ - **插件管理器拒绝安装**:确认 `@deepseek-ai/*` 在 `peerDependencies` 里,而不是 `dependencies`。
285
+ - **某个图族被拒绝**:这是设计行为。UML 2.5 的十四个图族在本构建里都有实现,所以拒绝永远是关于记号的:记号画不出这个视图,或画得出但读不回来。它按名拒绝并说明理由,不会交出错的模型。
286
+
287
+ ## 开发
288
+
289
+ ```bash
290
+ npm install
291
+ npm run typecheck # tsc --noEmit
292
+ npm run build # tsc → lib/(lib/ 必须与 src/ 同步提交)
293
+ npm run test:engine # 全部回归套件,含记忆门禁
294
+ npm run test:full # 端到端合并套件
295
+ npm run lint:md # markdownlint,与 CI 同一个版本
296
+ npm run bump -- <x.y.z> # 同步声明版本
297
+ npm run bump -- --check # 版本一致性
298
+ npm run bump -- --audit # 版本引用审计
299
+ ```
300
+
301
+ 外部检查器往返(`tests/external/run.mjs`)会调用真实的 `spin` 与 `gcc` 跑一遍导出结果。工具不在 PATH 上时整组自动跳过——跳过不算通过。要指向别处的可执行文件,用两个环境变量:
302
+
303
+ ```bash
304
+ MODEL_EVERYTHING_SPIN=/path/to/spin MODEL_EVERYTHING_GCC=/path/to/gcc npm run test:engine
305
+ ```
306
+
307
+ 插件自己不调用 `spin`、`gcc`、UPPAAL、TLA+ 或 PRISM:`model_export` 只写出它们能读的输入。
308
+
309
+ 约定、目录地图与硬约束见 [AGENTS.md](AGENTS.md)。项目记忆(调研结论、架构决定、交接)的入口在 [.github/memory/MEMORY.md](.github/memory/MEMORY.md)。
310
+
311
+ 想参与:两种来件的结构不同——**有出处的改进**(要引用方法、点名改哪个码、说明是改判定还是加信号,并附最邻近反例与一条能红的变异)与**运行中遇到的问题**(要原样引用报告、给最小复现),分别见 [CONTRIBUTING.md](CONTRIBUTING.md) 与 [.github/ISSUE_TEMPLATE/](.github/ISSUE_TEMPLATE/)。
312
+
313
+ ## 参考文献
314
+
315
+ 各条检查背后的已发表工作——以及哪些检查**没有**已发表来源——收在 [docs/references.md](docs/references.md)。每一条都从仓库里 `Provenance` 表**逐字提取**(生成器 `docs/references/generate.mjs`),并标注它在哪个文件里被引用。这份清单存在的意义是把「已发表方法」与「本仓库自己的约定」分开:多数检查是后者,而把约定当成引用写出来,比说明它是约定更糟。
316
+
317
+ ## 许可证与安全
318
+
319
+ MIT,见 [LICENSE](LICENSE)。安全策略见 [SECURITY.md](SECURITY.md)。
@@ -0,0 +1,20 @@
1
+ # dsh-model-everything bundle patch — two inserts over the profile root.
2
+ #
3
+ # Row ids are stable identity in the config tree; later layers (the user's profile
4
+ # cordis.patch.yml, $DSH_HOME/cordis.patch.yml, --patch overlays) override a row by
5
+ # id, replacing the whole `config` (no deep merge).
6
+ #
7
+ # Two components, two rows. The first carries the tools and the skills. The second
8
+ # injects a routing message at the start of a session; it is on by default, because a
9
+ # measured comparison showed it reaches the one request class the plugin otherwise
10
+ # never sees (a question the session believes it can answer from memory) without
11
+ # over-triggering a control task. Turn it off per deployment with `config.enabled:
12
+ # false`, the live switch on the Plugins page, or by disabling this row.
13
+
14
+ - insert:
15
+ - id: dsh-model-everything
16
+ name: 'dsh-model-everything'
17
+ - id: dsh-model-everything-gate
18
+ name: 'dsh-model-everything/gate'
19
+ config:
20
+ enabled: true
@@ -0,0 +1,48 @@
1
+ # Examples
2
+
3
+ Sample models to run as they are. These files are documentation, not test fixtures:
4
+ every suite reads its own fixtures from `tests/<suite>/fixtures/`, so nothing here is
5
+ asserted on and a file may be edited to show a different result.
6
+
7
+ ## State machine
8
+
9
+ - `order-state-machine.before.json` — order processing BEFORE model
10
+ - `order-state-machine.after.json` — AFTER model with an added VERIFY step
11
+
12
+ Both order examples include a `narrative` block that explains every state, every
13
+ event, and every (state, event) scenario in natural language — the model as shown
14
+ to the user before verification.
15
+
16
+ Run D1-D4 comparison:
17
+
18
+ ```bash
19
+ # DSH tool
20
+ model_verify model=examples/order-state-machine.after.json beforeModel=examples/order-state-machine.before.json
21
+ ```
22
+
23
+ ## Performance-sensitive control dispatcher
24
+
25
+ - `control-dispatcher.json` — a motor-mode / safety dispatch state machine (RESET → BOOT → READY → RUN/FAULT → SAFE/OFF). Every transition carries a `cost` (handler cost units) and a `budget` invariant bounds any mission path to 100; RUN declares `onEntry: ["sync_lock"]` / `onExit: ["sync_unlock"]` so A4 Pair Symmetry verifies the mode-register lock/unlock balance. Expected result: **0 errors** (worst path = 90 ≤ 100). The `watchdog_expiry` name also demos the informational `coverageNotes` (timing vocabulary routed to UPPAAL-class tools).
26
+ - `control-dispatcher.overbudget.json` — the same machine with a slower watchdog handler (cost 60 instead of 15), pushing the fault path to 135 > 100. Expected: **one `A12_BUDGET_OVER` error** with the shortest over-budget path `power_ok → calibrate_done → engage → watchdog_expiry`.
27
+
28
+ Run:
29
+
30
+ ```bash
31
+ # DSH tool
32
+ model_verify model=examples/control-dispatcher.json
33
+ model_verify model=examples/control-dispatcher.overbudget.json
34
+ ```
35
+
36
+ Fields used: transition `cost` (absent defaults to 1), invariant `kind: "budget"` (A12), state `onEntry`/`onExit` action lists (A4). Schema details in `skills/model-everything/references/dsh-model-schema.md`.
37
+
38
+ ## Data model
39
+
40
+ - `ecommerce-data-model.json` — classic e-commerce schema
41
+ - `user-migration.before.json` / `user-migration.after.json` — field rename migration
42
+
43
+ Run data-model verification:
44
+
45
+ ```bash
46
+ # DSH tool
47
+ model_datamodel_verify model=examples/user-migration.after.json beforeModel=examples/user-migration.before.json fieldMapping={"User.name":"User.fullName"}
48
+ ```
@@ -0,0 +1,113 @@
1
+ {
2
+ "schemaVersion": 1,
3
+ "init": "RESET",
4
+ "states": [
5
+ {
6
+ "id": "RESET"
7
+ },
8
+ {
9
+ "id": "BOOT"
10
+ },
11
+ {
12
+ "id": "READY"
13
+ },
14
+ {
15
+ "id": "RUN",
16
+ "onEntry": [
17
+ "sync_lock"
18
+ ],
19
+ "onExit": [
20
+ "sync_unlock"
21
+ ]
22
+ },
23
+ {
24
+ "id": "FAULT"
25
+ },
26
+ {
27
+ "id": "SAFE",
28
+ "terminal": true
29
+ },
30
+ {
31
+ "id": "OFF",
32
+ "terminal": true
33
+ }
34
+ ],
35
+ "transitions": [
36
+ {
37
+ "from": "RESET",
38
+ "event": "power_ok",
39
+ "to": "BOOT",
40
+ "cost": 10
41
+ },
42
+ {
43
+ "from": "BOOT",
44
+ "event": "calibrate_done",
45
+ "to": "READY",
46
+ "cost": 40
47
+ },
48
+ {
49
+ "from": "BOOT",
50
+ "event": "abort",
51
+ "to": "OFF",
52
+ "cost": 2
53
+ },
54
+ {
55
+ "from": "READY",
56
+ "event": "engage",
57
+ "to": "RUN",
58
+ "cost": 5
59
+ },
60
+ {
61
+ "from": "READY",
62
+ "event": "shutdown",
63
+ "to": "OFF",
64
+ "cost": 2
65
+ },
66
+ {
67
+ "from": "RUN",
68
+ "event": "cmd_done",
69
+ "to": "OFF",
70
+ "cost": 5
71
+ },
72
+ {
73
+ "from": "RUN",
74
+ "event": "watchdog_expiry",
75
+ "to": "FAULT",
76
+ "cost": 15
77
+ },
78
+ {
79
+ "from": "FAULT",
80
+ "event": "recover_ok",
81
+ "to": "SAFE",
82
+ "cost": 20
83
+ },
84
+ {
85
+ "from": "FAULT",
86
+ "event": "shutdown",
87
+ "to": "OFF",
88
+ "cost": 2
89
+ }
90
+ ],
91
+ "invariants": [
92
+ {
93
+ "id": "mission-budget",
94
+ "description": "any mission path completes within 100 cost units",
95
+ "kind": "budget",
96
+ "budget": 100
97
+ },
98
+ {
99
+ "id": "calibrate-first",
100
+ "description": "calibrate_done must precede engage",
101
+ "kind": "event-before-state",
102
+ "event": "calibrate_done",
103
+ "state": "RUN"
104
+ }
105
+ ],
106
+ "resourcePairs": [
107
+ {
108
+ "resource": "mode-register",
109
+ "acquireEvent": "sync_lock",
110
+ "releaseEvent": "sync_unlock"
111
+ }
112
+ ]
113
+ }
@@ -0,0 +1,113 @@
1
+ {
2
+ "schemaVersion": 1,
3
+ "init": "RESET",
4
+ "states": [
5
+ {
6
+ "id": "RESET"
7
+ },
8
+ {
9
+ "id": "BOOT"
10
+ },
11
+ {
12
+ "id": "READY"
13
+ },
14
+ {
15
+ "id": "RUN",
16
+ "onEntry": [
17
+ "sync_lock"
18
+ ],
19
+ "onExit": [
20
+ "sync_unlock"
21
+ ]
22
+ },
23
+ {
24
+ "id": "FAULT"
25
+ },
26
+ {
27
+ "id": "SAFE",
28
+ "terminal": true
29
+ },
30
+ {
31
+ "id": "OFF",
32
+ "terminal": true
33
+ }
34
+ ],
35
+ "transitions": [
36
+ {
37
+ "from": "RESET",
38
+ "event": "power_ok",
39
+ "to": "BOOT",
40
+ "cost": 10
41
+ },
42
+ {
43
+ "from": "BOOT",
44
+ "event": "calibrate_done",
45
+ "to": "READY",
46
+ "cost": 40
47
+ },
48
+ {
49
+ "from": "BOOT",
50
+ "event": "abort",
51
+ "to": "OFF",
52
+ "cost": 2
53
+ },
54
+ {
55
+ "from": "READY",
56
+ "event": "engage",
57
+ "to": "RUN",
58
+ "cost": 5
59
+ },
60
+ {
61
+ "from": "READY",
62
+ "event": "shutdown",
63
+ "to": "OFF",
64
+ "cost": 2
65
+ },
66
+ {
67
+ "from": "RUN",
68
+ "event": "cmd_done",
69
+ "to": "OFF",
70
+ "cost": 5
71
+ },
72
+ {
73
+ "from": "RUN",
74
+ "event": "watchdog_expiry",
75
+ "to": "FAULT",
76
+ "cost": 60
77
+ },
78
+ {
79
+ "from": "FAULT",
80
+ "event": "recover_ok",
81
+ "to": "SAFE",
82
+ "cost": 20
83
+ },
84
+ {
85
+ "from": "FAULT",
86
+ "event": "shutdown",
87
+ "to": "OFF",
88
+ "cost": 2
89
+ }
90
+ ],
91
+ "invariants": [
92
+ {
93
+ "id": "mission-budget",
94
+ "description": "any mission path completes within 100 cost units",
95
+ "kind": "budget",
96
+ "budget": 100
97
+ },
98
+ {
99
+ "id": "calibrate-first",
100
+ "description": "calibrate_done must precede engage",
101
+ "kind": "event-before-state",
102
+ "event": "calibrate_done",
103
+ "state": "RUN"
104
+ }
105
+ ],
106
+ "resourcePairs": [
107
+ {
108
+ "resource": "mode-register",
109
+ "acquireEvent": "sync_lock",
110
+ "releaseEvent": "sync_unlock"
111
+ }
112
+ ]
113
+ }