prd-workflow-cli 1.3.4 → 1.4.0

package/rules/schemas/rules.schema.json

@@ -0,0 +1,221 @@
+{
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "title": "PRD Rules Index",
+    "description": "PRD-CLI 规则索引的 JSON Schema",
+    "type": "object",
+    "required": [
+        "version",
+        "rules"
+    ],
+    "properties": {
+        "$schema": {
+            "type": "string"
+        },
+        "version": {
+            "type": "string",
+            "pattern": "^\\d+\\.\\d+\\.\\d+$"
+        },
+        "lastUpdated": {
+            "type": "string",
+            "format": "date"
+        },
+        "categories": {
+            "type": "object",
+            "additionalProperties": {
+                "type": "object",
+                "properties": {
+                    "name": {
+                        "type": "string"
+                    },
+                    "nameEn": {
+                        "type": "string"
+                    }
+                },
+                "required": [
+                    "name"
+                ]
+            }
+        },
+        "rules": {
+            "type": "array",
+            "items": {
+                "$ref": "#/definitions/rule"
+            }
+        },
+        "validators": {
+            "type": "object",
+            "additionalProperties": {
+                "$ref": "#/definitions/validator"
+            }
+        },
+        "scopeMapping": {
+            "type": "object",
+            "additionalProperties": {
+                "type": "string"
+            }
+        }
+    },
+    "definitions": {
+        "rule": {
+            "type": "object",
+            "required": [
+                "id",
+                "category",
+                "severity",
+                "scope",
+                "description",
+                "validatorType"
+            ],
+            "properties": {
+                "id": {
+                    "type": "string",
+                    "pattern": "^[A-Z]\\d{3}$",
+                    "description": "规则 ID，格式为 X000"
+                },
+                "category": {
+                    "type": "string",
+                    "enum": [
+                        "G",
+                        "D",
+                        "F",
+                        "S",
+                        "V",
+                        "I",
+                        "U",
+                        "C",
+                        "W"
+                    ],
+                    "description": "规则分类"
+                },
+                "severity": {
+                    "type": "string",
+                    "enum": [
+                        "CRITICAL",
+                        "HIGH",
+                        "MEDIUM",
+                        "LOW"
+                    ],
+                    "description": "严重程度"
+                },
+                "scope": {
+                    "type": "array",
+                    "items": {
+                        "type": "string",
+                        "enum": [
+                            "global",
+                            "p0",
+                            "b1",
+                            "b2",
+                            "plan",
+                            "c0",
+                            "c1",
+                            "version",
+                            "r1",
+                            "r2",
+                            "iteration",
+                            "a2ui"
+                        ]
+                    },
+                    "description": "适用范围"
+                },
+                "description": {
+                    "type": "string",
+                    "description": "规则描述"
+                },
+                "validatorType": {
+                    "type": "string",
+                    "enum": [
+                        "program",
+                        "ai-self-check",
+                        "hybrid"
+                    ],
+                    "description": "校验类型"
+                },
+                "validator": {
+                    "type": [
+                        "string",
+                        "null"
+                    ],
+                    "description": "校验器名称"
+                },
+                "checkLogic": {
+                    "type": "string",
+                    "description": "校验逻辑说明"
+                },
+                "examples": {
+                    "type": "object",
+                    "properties": {
+                        "correct": {
+                            "type": "string"
+                        },
+                        "wrong": {
+                            "type": "string"
+                        }
+                    }
+                },
+                "triggers": {
+                    "type": "array",
+                    "items": {
+                        "type": "string"
+                    },
+                    "description": "触发关键词"
+                },
+                "savePoints": {
+                    "type": "array",
+                    "items": {
+                        "type": "string"
+                    },
+                    "description": "保存触发点"
+                },
+                "questionTemplates": {
+                    "type": "array",
+                    "items": {
+                        "type": "string"
+                    },
+                    "description": "质疑问题模板"
+                },
+                "checkItems": {
+                    "type": "array",
+                    "items": {
+                        "type": "string"
+                    },
+                    "description": "检查项"
+                },
+                "dimensions": {
+                    "type": "array",
+                    "items": {
+                        "type": "string"
+                    },
+                    "description": "检查维度"
+                },
+                "dimensionDetails": {
+                    "type": "object",
+                    "description": "维度详细说明"
+                }
+            }
+        },
+        "validator": {
+            "type": "object",
+            "required": [
+                "description",
+                "status"
+            ],
+            "properties": {
+                "description": {
+                    "type": "string"
+                },
+                "implementedIn": {
+                    "type": "string"
+                },
+                "status": {
+                    "type": "string",
+                    "enum": [
+                        "planned",
+                        "implemented",
+                        "deprecated"
+                    ]
+                }
+            }
+        }
+    }
+}

package/scripts/inject-rules.js

@@ -0,0 +1,167 @@
+/**
+ * 规则注入工具
+ * 
+ * 用于在 workflow 文件头部注入规则子集表
+ * 
+ * 用法:
+ *   node scripts/inject-rules.js              # 注入所有 workflow
+ *   node scripts/inject-rules.js prd-c1       # 注入指定 workflow
+ */
+
+const fs = require('fs');
+const path = require('path');
+
+// 加载规则索引
+function loadRules() {
+    const rulesPath = path.join(__dirname, '../rules/index.json');
+    return JSON.parse(fs.readFileSync(rulesPath, 'utf-8'));
+}
+
+// Scope 到 Workflow 的映射
+const scopeToWorkflow = {
+    'p0': 'prd-p0-project-info',
+    'b1': 'prd-b1-planning-draft',
+    'b2': 'prd-b2-planning-breakdown',
+    'c1': 'prd-c1-requirement-list',
+    'r1': 'prd-r1-review',
+    'r2': 'prd-r2-review'
+};
+
+// 获取指定 scope 的规则
+function getRulesForScope(rules, scope) {
+    return rules.filter(rule =>
+        rule.scope.includes(scope) || rule.scope.includes('global')
+    );
+}
+
+// 生成规则表格 Markdown
+function generateRulesTable(rules, scopeName) {
+    const lines = [
+        '',
+        '---',
+        '',
+        '## 🚨 本阶段必须遵守的规则',
+        '',
+        '> ⚠️ AI 在执行任务前必须逐条确认以下规则。输出时需包含自检清单。',
+        '',
+        '| ID | 规则 | 严重程度 | 自检 |',
+        '|----|------|----------|------|'
+    ];
+
+    rules.forEach(rule => {
+        const severity = rule.severity === 'CRITICAL' ? '🔴 严重' :
+            rule.severity === 'HIGH' ? '🟠 高' :
+                rule.severity === 'MEDIUM' ? '🟡 中' : '🟢 低';
+        lines.push(`| ${rule.id} | ${rule.description} | ${severity} | ☐ |`);
+    });
+
+    lines.push('');
+    lines.push('**自检清单模板**（AI 输出时必须包含）：');
+    lines.push('```');
+    lines.push(`## ✅ 规则自检 (${scopeName})`);
+    rules.forEach(rule => {
+        lines.push(`- [ ] ${rule.id}: ${rule.description.substring(0, 30)}...`);
+    });
+    lines.push('```');
+    lines.push('');
+    lines.push('---');
+    lines.push('');
+
+    return lines.join('\n');
+}
+
+// 在 workflow 文件中注入规则表格
+function injectRulesToWorkflow(workflowPath, rules, scopeName) {
+    const content = fs.readFileSync(workflowPath, 'utf-8');
+
+    // 检查是否已有规则表格
+    if (content.includes('## 🚨 本阶段必须遵守的规则')) {
+        console.log(`  跳过（已有规则表格）: ${path.basename(workflowPath)}`);
+        return false;
+    }
+
+    // 找到第一个 # 标题的位置（跳过 frontmatter）
+    const lines = content.split('\n');
+    let insertIndex = 0;
+    let inFrontmatter = false;
+
+    for (let i = 0; i < lines.length; i++) {
+        if (lines[i].startsWith('---')) {
+            if (!inFrontmatter) {
+                inFrontmatter = true;
+            } else {
+                inFrontmatter = false;
+            }
+            continue;
+        }
+
+        // 找到第一个 # 开头的标题
+        if (!inFrontmatter && lines[i].startsWith('# ')) {
+            // 在标题之后插入
+            insertIndex = i + 1;
+            break;
+        }
+    }
+
+    if (insertIndex === 0) {
+        console.log(`  跳过（未找到标题）: ${path.basename(workflowPath)}`);
+        return false;
+    }
+
+    // 生成规则表格
+    const rulesTable = generateRulesTable(rules, scopeName);
+
+    // 插入规则表格
+    lines.splice(insertIndex, 0, rulesTable);
+
+    fs.writeFileSync(workflowPath, lines.join('\n'));
+    console.log(`  ✅ 已注入: ${path.basename(workflowPath)} (${rules.length} 条规则)`);
+    return true;
+}
+
+// 主函数
+function main() {
+    const rulesIndex = loadRules();
+    const workflowDir = path.join(__dirname, '../.agent/workflows');
+
+    console.log('🔧 规则注入工具');
+    console.log('');
+
+    let injected = 0;
+    let skipped = 0;
+
+    // 遍历所有 scope
+    for (const [scope, workflowName] of Object.entries(scopeToWorkflow)) {
+        const workflowPath = path.join(workflowDir, `${workflowName}.md`);
+
+        if (!fs.existsSync(workflowPath)) {
+            console.log(`  跳过（文件不存在）: ${workflowName}.md`);
+            skipped++;
+            continue;
+        }
+
+        const rules = getRulesForScope(rulesIndex.rules, scope);
+
+        if (injectRulesToWorkflow(workflowPath, rules, scope.toUpperCase())) {
+            injected++;
+        } else {
+            skipped++;
+        }
+    }
+
+    console.log('');
+    console.log(`完成：注入 ${injected} 个，跳过 ${skipped} 个`);
+}
+
+// 导出函数供其他模块使用
+module.exports = {
+    loadRules,
+    getRulesForScope,
+    generateRulesTable,
+    injectRulesToWorkflow
+};
+
+// 如果直接运行脚本
+if (require.main === module) {
+    main();
+}

package/templates/a2ui-standalone.html

@@ -68,7 +68,7 @@
 
     <script>
         // UI 数据（内嵌）
-        const UI_DATA = {{JSON_DATA}};
+        const UI_DATA = {{ JSON_DATA }};
 
         // A2UI 渲染器
         const { ConfigProvider, Card, Button, Input, Select, Table, Tabs, Tag, Badge, Space, Row, Col, Typography, Divider, Alert, Upload, Form } = antd;
@@ -93,7 +93,7 @@
                     case 'Button': return React.createElement(Button, { key: props.key, type: props.variant === 'secondary' ? 'default' : props.variant === 'danger' ? 'primary' : 'primary', danger: props.variant === 'danger', style: { marginRight: 8 } }, props.text);
                     case 'Text': return React.createElement(Text, { key: props.key, style: { display: 'block', marginBottom: 8 } }, props.content);
                     case 'Tabs': return React.createElement(Tabs, { key: props.key, items: (props.items || []).map((item, i) => ({ key: String(i), label: item })), style: { marginBottom: 16 } });
-                    case 'Table': 
+                    case 'Table':
                         const columns = (props.columns || []).map(col => {
                             const column = { key: col.key || col, dataIndex: col.key || col, title: col.title || col };
                             if (col.type === 'link') column.render = (text) => React.createElement('a', null, text);
@@ -112,7 +112,7 @@
                     case 'Box': return React.createElement(Card, { key: props.key, size: 'small', style: { minWidth: 120, textAlign: 'center', borderLeft: props.color ? `3px solid ${props.color}` : undefined } }, React.createElement(Text, { strong: true }, props.title), props.desc && React.createElement('div', null, React.createElement(Text, { type: 'secondary', style: { fontSize: 12 } }, props.desc)));
                     case 'Arrow': return React.createElement('div', { key: props.key, style: { color: 'white', fontSize: 24, textAlign: 'center' } }, (props.direction === 'up' ? '↑' : props.direction === 'left' ? '←' : props.direction === 'right' ? '→' : '↓'), props.label && React.createElement('span', { style: { fontSize: 12, marginLeft: 8 } }, props.label));
                     case 'Layer': return React.createElement('div', { key: props.key, style: { display: 'flex', flexWrap: 'wrap', gap: 12, justifyContent: 'center', width: '100%' } }, props.title && React.createElement('div', { style: { width: '100%', textAlign: 'center', color: 'rgba(255,255,255,0.8)', fontSize: 12, marginBottom: 8 } }, props.title), children && children.map((child, i) => renderNode({ ...child, key: i })));
-                    case 'DiagramGroup': return React.createElement('div', { key: props.key, style: { background: 'rgba(255,255,255,0.1)', border: '1px dashed rgba(255,255,255,0.3)', borderRadius: 8, padding: 16, width: '100%' } }, props.title && React.createElement('div', { style: { color: 'rgba(255,255,255,0.9)', fontSize: 14, marginBottom: 12 } }, props.title), React.createElement('div', { style: { display: 'flex', flexWrap: 'wrap', gap: 12, justifyContent: 'center' } }, children && children.map((child, i) => renderNode({ ...child, key: i })));
+                    case 'DiagramGroup': return React.createElement('div', { key: props.key, style: { background: 'rgba(255,255,255,0.1)', border: '1px dashed rgba(255,255,255,0.3)', borderRadius: 8, padding: 16, width: '100%' } }, props.title && React.createElement('div', { style: { color: 'rgba(255,255,255,0.9)', fontSize: 14, marginBottom: 12 } }, props.title), React.createElement('div', { style: { display: 'flex', flexWrap: 'wrap', gap: 12, justifyContent: 'center' } }, children && children.map((child, i) => renderNode({ ...child, key: i }))));
                     default: return React.createElement(Alert, { key: props.key, type: 'warning', message: `未知组件: ${type}` });
                 }
             };