@routerhub/agent-rules 1.5.109 → 1.5.111

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.
package/AGENTS.base.md CHANGED
@@ -152,6 +152,8 @@
152
152
  - ⚠️ **HTML 文档中的截图必须以 `data:image/png;base64,...` 内嵌,禁止用文件路径或相对链接引用外部 PNG 文件。** 文档会被打开、移动、分享,外部图片路径一旦脱离原目录就全部失效,文档里全是裂图。生成文档后,散落的零散 PNG 文件应一并清理,只保留 HTML 本身。
153
153
  - ⚠️ **curl 命令必须完整可复制执行,禁止省略关键参数。** 包括但不限于:API Key / Token(用占位符 `${API_KEY}` 或真实值标注)、请求体中的图片数据、完整的 URL。禁止用 `...` 或「省略其余参数」代替——看的人无法区分「这里不重要所以省略了」还是「这里我不会写所以跳过了」,前者让命令不可执行,后者掩盖了潜在的错误。
154
154
  - ⚠️ **测试用的图片等静态资源统一放到 `docs/images/` 目录,curl 命令中用相对路径引用**(如 `@docs/images/test.jpg`),确保命令在项目根目录下可直接执行。
155
+ - ⚠️ **一键执行脚本/命令必须能直接复制到终端执行,且文档中必须配「一键复制」按钮。** 每条命令必须完整可执行(禁止省略参数、禁止用 `...` 占位、禁止只给片段),在项目根目录下可直接运行;文档中命令块右上角必须提供复制按钮,点击即可将完整命令复制到剪贴板并给出「已复制」反馈。
156
+ - ⚠️ **文档中给出的每条命令/脚本,写入前必须亲自在终端实际执行验证过,确认确实可行后才能写入。** 执行失败的命令一律不得写入文档,禁止凭推断「应该能跑」就写进文档——推断得出的结论不能作为生成依据,必须实际测试过才能下结论。
155
157
 
156
158
  ## Go 规则
157
159
 
@@ -230,6 +232,7 @@
230
232
 
231
233
  - 新建文档使用 HTML 格式(`.html`)、中文文件名,存到 `docs/` 目录。
232
234
  - 使用 `/create-doc` skill 生成符合规范的 HTML 文档。
235
+ - ⚠️ **需求/方案/操作过程类文档必须按步骤逐段记录并详细说明**:文档按操作步骤逐段组织,每一步包含三要素——① 做了什么动作(点了什么按钮/执行了什么命令/打开了什么页面)② 该步骤对应的界面截图,带箭头/红框/提示文字标注指向关键操作点或关键数据(标注放空白区,不遮挡内容)③ 详细说明这一步的结果与验证点。禁止跳过步骤、禁止只贴截图不给说明、禁止用一句套话覆盖所有步骤的截图。图片一律 base64 内嵌。
233
236
 
234
237
  ## Figma 还原
235
238
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@routerhub/agent-rules",
3
- "version": "1.5.109",
3
+ "version": "1.5.111",
4
4
  "description": "Shared Copilot agent rules and guidelines for RouterHub projects",
5
5
  "main": "AGENTS.base.md",
6
6
  "bin": {
package/rules/global.md CHANGED
@@ -152,6 +152,8 @@ name: "通用规则"
152
152
  - ⚠️ **HTML 文档中的截图必须以 `data:image/png;base64,...` 内嵌,禁止用文件路径或相对链接引用外部 PNG 文件。** 文档会被打开、移动、分享,外部图片路径一旦脱离原目录就全部失效,文档里全是裂图。生成文档后,散落的零散 PNG 文件应一并清理,只保留 HTML 本身。
153
153
  - ⚠️ **curl 命令必须完整可复制执行,禁止省略关键参数。** 包括但不限于:API Key / Token(用占位符 `${API_KEY}` 或真实值标注)、请求体中的图片数据、完整的 URL。禁止用 `...` 或「省略其余参数」代替——看的人无法区分「这里不重要所以省略了」还是「这里我不会写所以跳过了」,前者让命令不可执行,后者掩盖了潜在的错误。
154
154
  - ⚠️ **测试用的图片等静态资源统一放到 `docs/images/` 目录,curl 命令中用相对路径引用**(如 `@docs/images/test.jpg`),确保命令在项目根目录下可直接执行。
155
+ - ⚠️ **一键执行脚本/命令必须能直接复制到终端执行,且文档中必须配「一键复制」按钮。** 每条命令必须完整可执行(禁止省略参数、禁止用 `...` 占位、禁止只给片段),在项目根目录下可直接运行;文档中命令块右上角必须提供复制按钮,点击即可将完整命令复制到剪贴板并给出「已复制」反馈。
156
+ - ⚠️ **文档中给出的每条命令/脚本,写入前必须亲自在终端实际执行验证过,确认确实可行后才能写入。** 执行失败的命令一律不得写入文档,禁止凭推断「应该能跑」就写进文档——推断得出的结论不能作为生成依据,必须实际测试过才能下结论。
155
157
 
156
158
  ## Go 规则
157
159
 
@@ -230,6 +232,7 @@ name: "通用规则"
230
232
 
231
233
  - 新建文档使用 HTML 格式(`.html`)、中文文件名,存到 `docs/` 目录。
232
234
  - 使用 `/create-doc` skill 生成符合规范的 HTML 文档。
235
+ - ⚠️ **需求/方案/操作过程类文档必须按步骤逐段记录并详细说明**:文档按操作步骤逐段组织,每一步包含三要素——① 做了什么动作(点了什么按钮/执行了什么命令/打开了什么页面)② 该步骤对应的界面截图,带箭头/红框/提示文字标注指向关键操作点或关键数据(标注放空白区,不遮挡内容)③ 详细说明这一步的结果与验证点。禁止跳过步骤、禁止只贴截图不给说明、禁止用一句套话覆盖所有步骤的截图。图片一律 base64 内嵌。
233
236
 
234
237
  ## Figma 还原
235
238
 
@@ -8,6 +8,9 @@ description: >-
8
8
  「做文档」「做个文档」「做报告」「做个报告」「做汇报」「做个汇报」「做方案」「做个方案」「做总结」「做个总结」。
9
9
  「搞文档」「搞个文档」「搞报告」「搞个报告」「整文档」「整个文档」「整报告」「整个报告」「弄文档」「弄个文档」「弄报告」「弄个报告」。
10
10
  「文档」「报告」「需求文档」「汇报」单独说且上下文在讨论产出物时也应触发。
11
+ 「生成一个截图版的html」「生成截图版html」「生成一个截图版」「生成截图版」「截图版文档」「截图版报告」「截图版说明」「截图版的」等任何「截图版」表述。
12
+ 「生成一个html」「生成html」「生成一个html文档」「生成html文档」「写个html」「写html」「做一个html」「做个html」「出一个html」「出个html」「搞个html」「整个html」「弄个html」「html文档」「html报告」等任何明确要求生成 HTML 的表述。
13
+ 「html」单独说且上下文在讨论产出物时也应触发。
11
14
  自动生成符合项目规范(HTML格式、中文文件名、base64内嵌图片、lightbox图片放大、截图为主文字为辅)的中文HTML文档,存放到docs/目录。
12
15
  ---
13
16
 
@@ -68,3 +71,20 @@ description: >-
68
71
  - 截图结果必须包含当前页面 URL
69
72
  - 标注(箭头、提示文字等)放在页面空白区域,不覆盖页面内容
70
73
  - 制作过程中产生的中间截图文件统一放到 `screenshots/` 目录
74
+
75
+ ### 分步操作记录(每步必录)
76
+
77
+ - ⚠️ 需求、方案、操作过程类文档必须按操作步骤逐段组织,每个步骤独立成段,禁止跳过任何步骤、禁止只贴图不给说明、禁止只写文字不放截图
78
+ - ⚠️ 每个步骤必须包含三要素:
79
+ 1. **做了什么动作**:说明该步骤执行的具体操作(点了什么按钮 / 执行了什么命令 / 打开了什么页面 / 填写了什么字段)
80
+ 2. **配截图**:该步骤对应的界面截图,必须带箭头/红框/提示文字标注指向关键操作点或关键数据,标注放在页面空白区域,不遮挡关键内容
81
+ 3. **详细说明结果**:这一步执行后出现了什么结果、验证了什么、为什么重要
82
+ - ⚠️ 步骤之间用编号衔接(步骤 1 → 步骤 2 → …),说明文字必须一图一句、逐张不同,禁止用一句套话覆盖所有步骤的截图
83
+ - 截图统一用 base64 data URI 内嵌,禁止引用外部图片文件
84
+
85
+ ### 命令与复制按钮
86
+
87
+ - ⚠️ 文档中出现的每条可执行命令/脚本,必须能**直接复制到终端执行**:命令完整可复制(禁止省略参数、禁止用 `...` 占位、禁止只给片段)、在项目根目录下可直接运行
88
+ - ⚠️ 每条命令/脚本写入文档前,必须**亲自在终端实际执行一遍验证确实可行**,验证通过后才能写入文档;执行失败的命令一律不得写入,禁止凭推断「应该能跑」就下结论
89
+ - ⚠️ 每个命令块必须配「一键复制」按钮:点击按钮将完整命令复制到剪贴板,并给出「已复制」反馈
90
+ - 复制按钮实现:命令块右上角放复制按钮 → 点击用 `navigator.clipboard.writeText(命令全文)` 复制(不可用时用 `document.execCommand('copy')` 兜底)→ 按钮文案短暂变为「已复制」→ 约 2 秒后恢复为「复制」