prd-workflow-cli 1.1.25

package/package.json

@@ -0,0 +1,74 @@
+{
+  "name": "prd-workflow-cli",
+  "version": "1.1.25",
+  "description": "产品需求管理规范 CLI 工具 - 基于 A→R→B→C 流程，集成 PM 确认机制和对话归档的需求管理命令行工具",
+  "main": "index.js",
+  "bin": {
+    "prd": "./bin/prd-cli.js"
+  },
+  "scripts": {
+    "test": "jest",
+    "test:cn": "jest --reporters=./tests/reporters/chinese-reporter.js",
+    "test:unit": "jest tests/unit",
+    "test:integration": "jest tests/integration",
+    "test:watch": "jest --watch",
+    "test:coverage": "jest --coverage",
+    "postinstall": "node scripts/postinstall.js"
+  },
+  "keywords": [
+    "prd",
+    "product",
+    "requirements",
+    "workflow",
+    "ai-assisted",
+    "okr",
+    "product-management",
+    "cli"
+  ],
+  "author": "Hou Tong",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/houtonghoutong/PRD-CLI"
+  },
+  "homepage": "https://github.com/houtonghoutong/PRD-CLI#readme",
+  "bugs": {
+    "url": "https://github.com/houtonghoutong/PRD-CLI/issues"
+  },
+  "dependencies": {
+    "chalk": "^4.1.2",
+    "commander": "^11.1.0",
+    "fs-extra": "^11.2.0",
+    "inquirer": "^8.2.5"
+  },
+  "engines": {
+    "node": ">=14.0.0"
+  },
+  "files": [
+    "bin/",
+    "commands/",
+    "scripts/",
+    ".agent/",
+    ".antigravity/",
+    "templates/",
+    ".cursorrules",
+    "AI-GUIDE.md",
+    "README.md",
+    "GUIDE.md"
+  ],
+  "devDependencies": {
+    "jest": "^29.7.0"
+  },
+  "jest": {
+    "testEnvironment": "node",
+    "testMatch": [
+      "**/tests/**/*.test.js"
+    ],
+    "testTimeout": 30000,
+    "coverageDirectory": "coverage",
+    "coveragePathIgnorePatterns": [
+      "/node_modules/",
+      "/tests/"
+    ]
+  }
+}

package/scripts/postinstall.js

@@ -0,0 +1,241 @@
+#!/usr/bin/env node
+
+/**
+ * postinstall 脚本
+ * 在 npm install 完成后自动执行，更新项目中的 workflows 和规则文件
+ */
+
+const fs = require('fs');
+const path = require('path');
+
+// 静默模式运行（减少安装时的输出噪音）
+const SILENT = process.env.PRD_POSTINSTALL_SILENT === 'true';
+
+function log(msg) {
+    if (!SILENT) {
+        console.log(msg);
+    }
+}
+
+function logError(msg) {
+    // 错误始终输出
+    console.error(msg);
+}
+
+/**
+ * 获取项目根目录（向上查找包含 .prd-config.json 的目录）
+ */
+function findProjectRoot(startDir) {
+    let currentDir = startDir;
+    const root = path.parse(currentDir).root;
+
+    while (currentDir !== root) {
+        const configPath = path.join(currentDir, '.prd-config.json');
+        if (fs.existsSync(configPath)) {
+            return currentDir;
+        }
+        currentDir = path.dirname(currentDir);
+    }
+
+    return null;
+}
+
+/**
+ * 比较文件是否有变化
+ */
+function filesAreDifferent(sourcePath, targetPath) {
+    if (!fs.existsSync(targetPath)) {
+        return true;
+    }
+
+    try {
+        const sourceContent = fs.readFileSync(sourcePath, 'utf8');
+        const targetContent = fs.readFileSync(targetPath, 'utf8');
+        return sourceContent !== targetContent;
+    } catch {
+        return true;
+    }
+}
+
+/**
+ * 递归复制目录
+ */
+function copyDirSync(src, dest) {
+    if (!fs.existsSync(dest)) {
+        fs.mkdirSync(dest, { recursive: true });
+    }
+
+    const entries = fs.readdirSync(src, { withFileTypes: true });
+
+    for (const entry of entries) {
+        const srcPath = path.join(src, entry.name);
+        const destPath = path.join(dest, entry.name);
+
+        if (entry.isDirectory()) {
+            copyDirSync(srcPath, destPath);
+        } else {
+            fs.copyFileSync(srcPath, destPath);
+        }
+    }
+}
+
+/**
+ * 获取目录下所有文件（递归）
+ */
+function getAllFiles(dirPath, basePath = dirPath) {
+    const files = [];
+
+    if (!fs.existsSync(dirPath)) {
+        return files;
+    }
+
+    const entries = fs.readdirSync(dirPath, { withFileTypes: true });
+
+    for (const entry of entries) {
+        const fullPath = path.join(dirPath, entry.name);
+
+        if (entry.isDirectory()) {
+            files.push(...getAllFiles(fullPath, basePath));
+        } else {
+            files.push({
+                fullPath,
+                relativePath: path.relative(basePath, fullPath)
+            });
+        }
+    }
+
+    return files;
+}
+
+/**
+ * 主函数
+ */
+function main() {
+    try {
+        // 获取 npm 包的路径（当前脚本所在目录的上级）
+        const packagePath = path.join(__dirname, '..');
+
+        // 尝试找到项目根目录
+        // 通常 node_modules 在项目根目录下，所以向上查找
+        const nodeModulesPath = path.dirname(path.dirname(packagePath));
+        const potentialProjectRoot = path.dirname(nodeModulesPath);
+
+        // 检查是否是 PRD 项目
+        const projectRoot = findProjectRoot(potentialProjectRoot);
+
+        if (!projectRoot) {
+            // 不是 PRD 项目，静默退出（这是正常情况，比如全局安装）
+            return;
+        }
+
+        log('\n📦 prd-workflow-cli: 检测到 PRD 项目，正在更新配置文件...');
+
+        // 定义需要更新的文件/目录
+        const updateItems = [
+            {
+                name: 'Workflows',
+                source: '.agent/workflows',
+                target: '.agent/workflows',
+                isDir: true
+            },
+            {
+                name: 'Cursor Rules',
+                source: '.cursorrules',
+                target: '.cursorrules',
+                isDir: false
+            },
+            {
+                name: 'Antigravity Rules',
+                source: '.antigravity',
+                target: '.antigravity',
+                isDir: true
+            },
+            {
+                name: 'AI Guide',
+                source: 'AI-GUIDE.md',
+                target: 'AI-GUIDE.md',
+                isDir: false
+            }
+        ];
+
+        let updatedCount = 0;
+        let newCount = 0;
+
+        for (const item of updateItems) {
+            const sourcePath = path.join(packagePath, item.source);
+            const targetPath = path.join(projectRoot, item.target);
+
+            if (!fs.existsSync(sourcePath)) {
+                continue;
+            }
+
+            if (item.isDir) {
+                // 处理目录
+                const files = getAllFiles(sourcePath);
+
+                for (const file of files) {
+                    const targetFilePath = path.join(targetPath, file.relativePath);
+                    const isNew = !fs.existsSync(targetFilePath);
+                    const isDifferent = filesAreDifferent(file.fullPath, targetFilePath);
+
+                    if (isDifferent) {
+                        // 确保目标目录存在
+                        const targetDir = path.dirname(targetFilePath);
+                        if (!fs.existsSync(targetDir)) {
+                            fs.mkdirSync(targetDir, { recursive: true });
+                        }
+
+                        fs.copyFileSync(file.fullPath, targetFilePath);
+
+                        if (isNew) {
+                            newCount++;
+                        } else {
+                            updatedCount++;
+                        }
+                    }
+                }
+            } else {
+                // 处理单个文件
+                const isNew = !fs.existsSync(targetPath);
+                const isDifferent = filesAreDifferent(sourcePath, targetPath);
+
+                if (isDifferent) {
+                    // 确保目标目录存在
+                    const targetDir = path.dirname(targetPath);
+                    if (!fs.existsSync(targetDir)) {
+                        fs.mkdirSync(targetDir, { recursive: true });
+                    }
+
+                    fs.copyFileSync(sourcePath, targetPath);
+
+                    if (isNew) {
+                        newCount++;
+                    } else {
+                        updatedCount++;
+                    }
+                }
+            }
+        }
+
+        // 输出结果
+        if (newCount > 0 || updatedCount > 0) {
+            if (newCount > 0) {
+                log(`   ✨ 新增 ${newCount} 个文件`);
+            }
+            if (updatedCount > 0) {
+                log(`   🔄 更新 ${updatedCount} 个文件`);
+            }
+            log('   ✅ 配置文件已同步到最新版本\n');
+        } else {
+            log('   ✅ 所有配置文件已是最新版本\n');
+        }
+
+    } catch (error) {
+        // postinstall 失败不应该阻止安装
+        // 只输出警告，不抛出错误
+        logError(`\n⚠️ prd-workflow-cli: 自动更新配置文件失败: ${error.message}`);
+        logError('   您可以稍后手动运行 "prd upgrade" 来更新配置文件\n');
+    }
+}
+
+main();

package/templates/README-FOR-NEW-USER.md

@@ -0,0 +1,105 @@
+# 🚀 新用户必读 - PRD 工作流项目
+
+欢迎使用本项目！在开始之前，请先完成以下设置。
+
+---
+
+## 第 1 步：安装项目依赖
+
+在项目根目录运行：
+
+```bash
+npm install
+```
+
+这会安装 `prd-workflow-cli` 和其他依赖。
+
+---
+
+## 第 2 步：验证安装
+
+安装完成后，运行以下命令验证：
+
+```bash
+npx prd --version
+```
+
+如果显示版本号（如 `1.1.12`），说明安装成功。
+
+---
+
+## 第 3 步：使用 CLI 命令
+
+**⚠️ 重要：请使用 `npx prd` 而不是 `prd`**
+
+```bash
+# 查看项目状态
+npx prd status
+
+# 创建基线文档
+npx prd baseline create A0
+
+# 创建规划文档
+npx prd plan create B1
+
+# 执行审视
+npx prd review r1
+```
+
+### 其他 IDE
+
+请参考 `.agent/workflows/` 目录中的工作流文档。
+
+---
+
+## 第 3 步：了解项目结构
+
+```
+项目目录/
+├── 00_项目总览/          # P0 项目基本信息
+├── 01_产品基线/          # A0/A1/A2/R0 基线文档
+├── 02_迭代记录/          # 每轮迭代的 B/C/R 文档
+├── 98_对话归档/          # PM 与 AI 的对话记录
+├── 99_归档区/            # 历史版本归档
+├── .agent/workflows/     # AI 工作流规则
+├── .cursorrules          # Cursor AI 行为规则
+└── .prd-config.json      # 项目配置
+```
+
+---
+
+## 第 4 步：开始使用
+
+### 查看项目状态
+
+```bash
+prd status
+```
+
+### 常用命令
+
+| 命令 | 用途 |
+|------|------|
+| `prd status` | 查看当前状态 |
+| `prd iteration list` | 列出所有迭代 |
+| `prd plan create B1` | 创建规划草案 |
+| `prd review r1` | 执行 R1 审视 |
+| `prd version create C1` | 创建版本需求清单 |
+
+---
+
+## 遇到问题？
+
+1. **命令提示 `prd: command not found`**
+   - 说明 CLI 未安装，请回到第 1 步
+
+2. **提示 "当前目录不是一个 PRD 项目"**
+   - 确保你在项目根目录（包含 `.prd-config.json` 的目录）
+
+3. **AI 行为不正确**
+   - 检查 `.cursorrules` 文件是否存在
+   - 可以提醒 AI："请遵循 .cursorrules 的规则"
+
+---
+
+**Happy Working! 🎉**

package/templates/dialog-template.md

@@ -0,0 +1,109 @@
+# [文档名称] - 对话记录
+
+**创建时间**: [YYYY-MM-DD HH:MM:SS]  
+**迭代轮次**: [第 XX 轮迭代 / 基线阶段]  
+**文档类型**: [P0/A0/A1/A2/R0/B1/B2/R1/C0/C1/R2]
+
+---
+
+## 💬 对话 #1
+
+**时间**: [YYYY-MM-DD HH:MM:SS]  
+**讨论主题**: [主题描述]
+
+### 🤖 AI [提问/分析/建议]
+> [AI 的具体内容]
+> 
+> [如果有多行，继续写...]
+
+### 🧑 PM [回答/决策/选择]
+> [PM 的具体内容]
+> 
+> [PM 的原话，不要总结]
+
+### 🤖 AI [引导/总结/确认]
+> [AI 的回复内容]
+
+### ✅ PM 确认
+> [PM 的确认内容]
+
+### 📝 AI 执行
+> [AI 写入了什么文件、哪个章节]
+
+---
+
+## 💬 对话 #2
+
+**时间**: [YYYY-MM-DD HH:MM:SS]  
+**讨论主题**: [主题描述]
+
+### 🤖 AI 提问
+> [内容]
+
+### 🧑 PM 回答
+> [内容]
+
+### 🤖 AI 总结
+> [内容]
+
+### ✅ PM 确认
+> [内容]
+
+### 📝 AI 执行
+> [内容]
+
+---
+
+## 📊 对话统计
+
+- **总对话轮次**: [N] 轮
+- **PM 决策次数**: [N] 次
+- **AI 提问次数**: [N] 次
+- **AI 建议次数**: [N] 次
+- **写入文件次数**: [N] 次
+
+---
+
+## 🔑 关键决策
+
+| 决策项 | PM 决策 | 理由 |
+|--------|---------|------|
+| [决策1] | [决定] | [原因] |
+| [决策2] | [决定] | [原因] |
+
+---
+
+**归档完成时间**: [YYYY-MM-DD HH:MM:SS]
+
+---
+
+## 📝 使用说明
+
+### 什么时候使用这个模板？
+
+AI 在以下时机必须归档对话：
+1. **每完成一个文档部分**（如 B1 的"规划目标"章节）
+2. **每次 PM 做出决策**（如选择采纳哪个建议）
+3. **每轮战略分析完成后**（如 B2 的分析 → 质疑 → 建议 → 决策）
+
+### 如何使用？
+
+1. 复制这个模板
+2. 修改文件名：如 `B1_对话记录.md`
+3. 填写对话内容（保持格式）
+4. 及时追加新的对话轮次
+
+### 归档原则
+
+- ✅ 完整记录对话过程（不只是结论）
+- ✅ 保留 PM 的原话（不要总结）
+- ✅ 记录 AI 的引导过程
+- ✅ 标注时间戳
+- ✅ 及时归档（不要积累）
+
+### 不要
+
+- ❌ 只记录结论
+- ❌ 等到全部完成再归档
+- ❌ 省略中间过程
+- ❌ 总结或改写 PM 的话