openfeel 1.0.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 (196) hide show
  1. package/LICENSE +21 -0
  2. package/README.en.md +140 -0
  3. package/README.md +17 -0
  4. package/README.zh-CN.md +140 -0
  5. package/bin/openfeel.js +13 -0
  6. package/dist/cli/index.d.ts +11 -0
  7. package/dist/cli/index.d.ts.map +1 -0
  8. package/dist/cli/index.js +119 -0
  9. package/dist/cli/index.js.map +1 -0
  10. package/dist/cli/repl.d.ts +10 -0
  11. package/dist/cli/repl.d.ts.map +1 -0
  12. package/dist/cli/repl.js +74 -0
  13. package/dist/cli/repl.js.map +1 -0
  14. package/dist/commands/archive.d.ts +7 -0
  15. package/dist/commands/archive.d.ts.map +1 -0
  16. package/dist/commands/archive.js +38 -0
  17. package/dist/commands/archive.js.map +1 -0
  18. package/dist/commands/config.d.ts +15 -0
  19. package/dist/commands/config.d.ts.map +1 -0
  20. package/dist/commands/config.js +208 -0
  21. package/dist/commands/config.js.map +1 -0
  22. package/dist/commands/flow.d.ts +24 -0
  23. package/dist/commands/flow.d.ts.map +1 -0
  24. package/dist/commands/flow.js +1024 -0
  25. package/dist/commands/flow.js.map +1 -0
  26. package/dist/commands/init.d.ts +9 -0
  27. package/dist/commands/init.d.ts.map +1 -0
  28. package/dist/commands/init.js +62 -0
  29. package/dist/commands/init.js.map +1 -0
  30. package/dist/commands/instructions.d.ts +7 -0
  31. package/dist/commands/instructions.d.ts.map +1 -0
  32. package/dist/commands/instructions.js +36 -0
  33. package/dist/commands/instructions.js.map +1 -0
  34. package/dist/commands/knowledge.d.ts +7 -0
  35. package/dist/commands/knowledge.d.ts.map +1 -0
  36. package/dist/commands/knowledge.js +174 -0
  37. package/dist/commands/knowledge.js.map +1 -0
  38. package/dist/commands/lint.d.ts +12 -0
  39. package/dist/commands/lint.d.ts.map +1 -0
  40. package/dist/commands/lint.js +192 -0
  41. package/dist/commands/lint.js.map +1 -0
  42. package/dist/commands/plan.d.ts +7 -0
  43. package/dist/commands/plan.d.ts.map +1 -0
  44. package/dist/commands/plan.js +73 -0
  45. package/dist/commands/plan.js.map +1 -0
  46. package/dist/commands/project.d.ts +7 -0
  47. package/dist/commands/project.d.ts.map +1 -0
  48. package/dist/commands/project.js +189 -0
  49. package/dist/commands/project.js.map +1 -0
  50. package/dist/commands/roadmap.d.ts +7 -0
  51. package/dist/commands/roadmap.d.ts.map +1 -0
  52. package/dist/commands/roadmap.js +26 -0
  53. package/dist/commands/roadmap.js.map +1 -0
  54. package/dist/commands/stage.d.ts +17 -0
  55. package/dist/commands/stage.d.ts.map +1 -0
  56. package/dist/commands/stage.js +291 -0
  57. package/dist/commands/stage.js.map +1 -0
  58. package/dist/commands/update.d.ts +8 -0
  59. package/dist/commands/update.d.ts.map +1 -0
  60. package/dist/commands/update.js +87 -0
  61. package/dist/commands/update.js.map +1 -0
  62. package/dist/commands/view.d.ts +7 -0
  63. package/dist/commands/view.d.ts.map +1 -0
  64. package/dist/commands/view.js +77 -0
  65. package/dist/commands/view.js.map +1 -0
  66. package/dist/core/archive/merge.d.ts +20 -0
  67. package/dist/core/archive/merge.d.ts.map +1 -0
  68. package/dist/core/archive/merge.js +118 -0
  69. package/dist/core/archive/merge.js.map +1 -0
  70. package/dist/core/artifact-graph/graph.d.ts +62 -0
  71. package/dist/core/artifact-graph/graph.d.ts.map +1 -0
  72. package/dist/core/artifact-graph/graph.js +184 -0
  73. package/dist/core/artifact-graph/graph.js.map +1 -0
  74. package/dist/core/artifact-graph/index.d.ts +10 -0
  75. package/dist/core/artifact-graph/index.d.ts.map +1 -0
  76. package/dist/core/artifact-graph/index.js +8 -0
  77. package/dist/core/artifact-graph/index.js.map +1 -0
  78. package/dist/core/artifact-graph/instruction-loader.d.ts +35 -0
  79. package/dist/core/artifact-graph/instruction-loader.d.ts.map +1 -0
  80. package/dist/core/artifact-graph/instruction-loader.js +358 -0
  81. package/dist/core/artifact-graph/instruction-loader.js.map +1 -0
  82. package/dist/core/artifact-graph/resolver.d.ts +10 -0
  83. package/dist/core/artifact-graph/resolver.d.ts.map +1 -0
  84. package/dist/core/artifact-graph/resolver.js +32 -0
  85. package/dist/core/artifact-graph/resolver.js.map +1 -0
  86. package/dist/core/artifact-graph/state.d.ts +9 -0
  87. package/dist/core/artifact-graph/state.d.ts.map +1 -0
  88. package/dist/core/artifact-graph/state.js +24 -0
  89. package/dist/core/artifact-graph/state.js.map +1 -0
  90. package/dist/core/artifact-graph/types.d.ts +22 -0
  91. package/dist/core/artifact-graph/types.d.ts.map +1 -0
  92. package/dist/core/artifact-graph/types.js +2 -0
  93. package/dist/core/artifact-graph/types.js.map +1 -0
  94. package/dist/core/config.d.ts +256 -0
  95. package/dist/core/config.d.ts.map +1 -0
  96. package/dist/core/config.js +393 -0
  97. package/dist/core/config.js.map +1 -0
  98. package/dist/core/flow-manager.d.ts +492 -0
  99. package/dist/core/flow-manager.d.ts.map +1 -0
  100. package/dist/core/flow-manager.js +2379 -0
  101. package/dist/core/flow-manager.js.map +1 -0
  102. package/dist/core/i18n-data/en.d.ts +26 -0
  103. package/dist/core/i18n-data/en.d.ts.map +1 -0
  104. package/dist/core/i18n-data/en.js +492 -0
  105. package/dist/core/i18n-data/en.js.map +1 -0
  106. package/dist/core/i18n-data/types.d.ts +18 -0
  107. package/dist/core/i18n-data/types.d.ts.map +1 -0
  108. package/dist/core/i18n-data/types.js +8 -0
  109. package/dist/core/i18n-data/types.js.map +1 -0
  110. package/dist/core/i18n-data/zh-CN.d.ts +28 -0
  111. package/dist/core/i18n-data/zh-CN.d.ts.map +1 -0
  112. package/dist/core/i18n-data/zh-CN.js +524 -0
  113. package/dist/core/i18n-data/zh-CN.js.map +1 -0
  114. package/dist/core/i18n.d.ts +40 -0
  115. package/dist/core/i18n.d.ts.map +1 -0
  116. package/dist/core/i18n.js +135 -0
  117. package/dist/core/i18n.js.map +1 -0
  118. package/dist/core/init.d.ts +22 -0
  119. package/dist/core/init.d.ts.map +1 -0
  120. package/dist/core/init.js +292 -0
  121. package/dist/core/init.js.map +1 -0
  122. package/dist/core/metrics.d.ts +60 -0
  123. package/dist/core/metrics.d.ts.map +1 -0
  124. package/dist/core/metrics.js +137 -0
  125. package/dist/core/metrics.js.map +1 -0
  126. package/dist/core/pipeline-schema.d.ts +78 -0
  127. package/dist/core/pipeline-schema.d.ts.map +1 -0
  128. package/dist/core/pipeline-schema.js +57 -0
  129. package/dist/core/pipeline-schema.js.map +1 -0
  130. package/dist/core/plan/roadmap.d.ts +17 -0
  131. package/dist/core/plan/roadmap.d.ts.map +1 -0
  132. package/dist/core/plan/roadmap.js +71 -0
  133. package/dist/core/plan/roadmap.js.map +1 -0
  134. package/dist/core/plan/scheme.d.ts +34 -0
  135. package/dist/core/plan/scheme.d.ts.map +1 -0
  136. package/dist/core/plan/scheme.js +262 -0
  137. package/dist/core/plan/scheme.js.map +1 -0
  138. package/dist/core/plan/stage.d.ts +20 -0
  139. package/dist/core/plan/stage.d.ts.map +1 -0
  140. package/dist/core/plan/stage.js +120 -0
  141. package/dist/core/plan/stage.js.map +1 -0
  142. package/dist/core/public-logger.d.ts +84 -0
  143. package/dist/core/public-logger.d.ts.map +1 -0
  144. package/dist/core/public-logger.js +344 -0
  145. package/dist/core/public-logger.js.map +1 -0
  146. package/dist/core/schema.d.ts +70 -0
  147. package/dist/core/schema.d.ts.map +1 -0
  148. package/dist/core/schema.js +61 -0
  149. package/dist/core/schema.js.map +1 -0
  150. package/dist/core/template-loader.d.ts +22 -0
  151. package/dist/core/template-loader.d.ts.map +1 -0
  152. package/dist/core/template-loader.js +2848 -0
  153. package/dist/core/template-loader.js.map +1 -0
  154. package/dist/core/templates.d.ts +18 -0
  155. package/dist/core/templates.d.ts.map +1 -0
  156. package/dist/core/templates.js +50 -0
  157. package/dist/core/templates.js.map +1 -0
  158. package/dist/core/update.d.ts +40 -0
  159. package/dist/core/update.d.ts.map +1 -0
  160. package/dist/core/update.js +1569 -0
  161. package/dist/core/update.js.map +1 -0
  162. package/dist/core/view/entry.d.ts +37 -0
  163. package/dist/core/view/entry.d.ts.map +1 -0
  164. package/dist/core/view/entry.js +108 -0
  165. package/dist/core/view/entry.js.map +1 -0
  166. package/dist/core/workspace/identity.d.ts +60 -0
  167. package/dist/core/workspace/identity.d.ts.map +1 -0
  168. package/dist/core/workspace/identity.js +169 -0
  169. package/dist/core/workspace/identity.js.map +1 -0
  170. package/dist/core/workspace/knowledge.d.ts +55 -0
  171. package/dist/core/workspace/knowledge.d.ts.map +1 -0
  172. package/dist/core/workspace/knowledge.js +230 -0
  173. package/dist/core/workspace/knowledge.js.map +1 -0
  174. package/dist/core/workspace/structure.d.ts +9 -0
  175. package/dist/core/workspace/structure.d.ts.map +1 -0
  176. package/dist/core/workspace/structure.js +59 -0
  177. package/dist/core/workspace/structure.js.map +1 -0
  178. package/dist/index.d.ts +7 -0
  179. package/dist/index.d.ts.map +1 -0
  180. package/dist/index.js +7 -0
  181. package/dist/index.js.map +1 -0
  182. package/dist/utils/kb-dedup.d.ts +46 -0
  183. package/dist/utils/kb-dedup.d.ts.map +1 -0
  184. package/dist/utils/kb-dedup.js +169 -0
  185. package/dist/utils/kb-dedup.js.map +1 -0
  186. package/dist/utils/path.d.ts +22 -0
  187. package/dist/utils/path.d.ts.map +1 -0
  188. package/dist/utils/path.js +37 -0
  189. package/dist/utils/path.js.map +1 -0
  190. package/package.json +61 -0
  191. package/schemas/spec-driven/schema.yaml +50 -0
  192. package/schemas/spec-driven/templates/design.md +43 -0
  193. package/schemas/spec-driven/templates/plan.md +46 -0
  194. package/schemas/spec-driven/templates/proposal.md +35 -0
  195. package/schemas/spec-driven/templates/tasks.md +39 -0
  196. package/scripts/patch-inquirer.js +70 -0
package/package.json ADDED
@@ -0,0 +1,61 @@
1
+ {
2
+ "name": "openfeel",
3
+ "version": "1.0.0",
4
+ "description": "AI Agent 开发流程治理 CLI 工具",
5
+ "type": "module",
6
+ "private": false,
7
+ "bin": {
8
+ "openfeel": "./bin/openfeel.js"
9
+ },
10
+ "exports": {
11
+ ".": "./dist/index.js"
12
+ },
13
+ "scripts": {
14
+ "build": "node build.js",
15
+ "test": "vitest run",
16
+ "dev": "vitest",
17
+ "postinstall": "node scripts/patch-inquirer.js"
18
+ },
19
+ "dependencies": {
20
+ "@inquirer/prompts": "^8.5.2",
21
+ "commander": "^14.0.0",
22
+ "fast-glob": "^3.3.3",
23
+ "yaml": "^2.9.0",
24
+ "zod": "^4.4.3"
25
+ },
26
+ "devDependencies": {
27
+ "@types/node": "^22.0.0",
28
+ "eslint": "^9.0.0",
29
+ "typescript": "^5.7.0",
30
+ "typescript-eslint": "^8.0.0",
31
+ "vitest": "^3.0.0",
32
+ "@vitest/coverage-v8": "^3.0.0"
33
+ },
34
+ "engines": {
35
+ "node": ">=20.0.0"
36
+ },
37
+ "license": "MIT",
38
+ "repository": {
39
+ "type": "git",
40
+ "url": "https://github.com/Liuary/OpenFeel.git"
41
+ },
42
+ "bugs": {
43
+ "url": "https://github.com/Liuary/OpenFeel/issues"
44
+ },
45
+ "keywords": [
46
+ "ai-agent",
47
+ "cli",
48
+ "workflow",
49
+ "governance",
50
+ "openfeel"
51
+ ],
52
+ "publishConfig": {
53
+ "access": "public"
54
+ },
55
+ "files": [
56
+ "dist",
57
+ "bin",
58
+ "schemas",
59
+ "scripts"
60
+ ]
61
+ }
@@ -0,0 +1,50 @@
1
+ name: spec-driven
2
+ version: "1.0"
3
+ description: "规范驱动开发工作流 — proposal → specs → design → tasks → implementation → review → archive"
4
+
5
+ artifacts:
6
+ - id: proposal
7
+ description: "项目提案文档"
8
+ generates: "docs/proposal.md"
9
+ template: "proposal.md"
10
+ requires: []
11
+ instruction: "创建项目提案文档,描述项目目标、范围和初步技术方案"
12
+
13
+ - id: specs
14
+ description: "功能规范文档"
15
+ generates: "docs/specs/**/*.md"
16
+ template: "plan.md"
17
+ dependsOn: ["proposal"]
18
+ instruction: "根据提案撰写详细功能规范"
19
+
20
+ - id: design
21
+ description: "技术设计文档"
22
+ generates: "docs/design.md"
23
+ template: "design.md"
24
+ dependsOn: ["specs"]
25
+ instruction: "根据规范制定技术设计方案"
26
+
27
+ - id: tasks
28
+ description: "任务分解"
29
+ generates: "docs/tasks.md"
30
+ template: "tasks.md"
31
+ dependsOn: ["design"]
32
+ instruction: "将设计方案分解为可执行的开发任务"
33
+
34
+ - id: implementation
35
+ description: "代码实现"
36
+ generates: "src/**/*.ts"
37
+ dependsOn: ["tasks"]
38
+ instruction: "按照任务列表进行代码实现"
39
+
40
+ - id: review
41
+ description: "代码审查"
42
+ generates: "docs/review.md"
43
+ dependsOn: ["implementation"]
44
+ instruction: "对实现代码进行审查,输出审查报告"
45
+
46
+ - id: archive
47
+ description: "项目归档"
48
+ generates: "docs/archive.md"
49
+ dependsOn: ["review"]
50
+ instruction: "归档项目文档和最终产出"
@@ -0,0 +1,43 @@
1
+ # 技术设计
2
+
3
+ > 基于规范:{specs_link}
4
+
5
+ ## 架构概览
6
+
7
+ <!-- 系统整体架构图(可用 Mermaid 或文字描述) -->
8
+
9
+ ## 技术选型
10
+
11
+ | 层级 | 技术 | 理由 |
12
+ |------|------|------|
13
+ | | | |
14
+
15
+ ## 模块设计
16
+
17
+ ### 模块 A: {名称}
18
+
19
+ <!-- 职责、接口、依赖关系 -->
20
+
21
+ ### 模块 B: {名称}
22
+
23
+ <!-- 职责、接口、依赖关系 -->
24
+
25
+ ## 数据流
26
+
27
+ <!-- 描述核心业务流程的数据流动 -->
28
+
29
+ ## 接口规范
30
+
31
+ <!-- 各模块间的契约和接口定义 -->
32
+
33
+ ## 错误处理
34
+
35
+ <!-- 异常情况的处理策略 -->
36
+
37
+ ## 安全设计
38
+
39
+ <!-- 安全相关设计(鉴权、数据加密等) -->
40
+
41
+ ## 部署与运维
42
+
43
+ <!-- 部署方案、监控、日志策略 -->
@@ -0,0 +1,46 @@
1
+ # 功能规范
2
+
3
+ > 基于提案:{proposal_link}
4
+
5
+ ## 功能概览
6
+
7
+ <!-- 以用户视角描述系统功能 -->
8
+
9
+ ## 用户故事
10
+
11
+ <!-- 按用户角色编写的功能需求 -->
12
+
13
+ ### 故事 1: {标题}
14
+
15
+ **作为** {角色}
16
+ **我想要** {功能}
17
+ **以便于** {目标}
18
+
19
+ #### 验收标准
20
+
21
+ - [ ]
22
+
23
+ ## 功能需求
24
+
25
+ ### FR-01: {功能名称}
26
+
27
+ <!-- 详细描述功能需求 -->
28
+
29
+ ## 非功能需求
30
+
31
+ - 性能:
32
+ - 安全:
33
+ - 可用性:
34
+ - 可维护性:
35
+
36
+ ## 接口定义
37
+
38
+ <!-- 如有 API 或模块接口,在此定义 -->
39
+
40
+ ## 数据模型
41
+
42
+ <!-- 核心数据实体和关系描述 -->
43
+
44
+ ## 边界与约束
45
+
46
+ <!-- 本阶段的边界条件和限制 -->
@@ -0,0 +1,35 @@
1
+ # 项目提案
2
+
3
+ > 项目名称:{project_name}
4
+
5
+ ## 项目目标
6
+
7
+ <!-- 描述项目要解决的核心问题和期望达成的目标 -->
8
+
9
+ ## 项目范围
10
+
11
+ <!-- 明确项目边界,列出包含和不包含的功能 -->
12
+
13
+ ### 包含范围
14
+
15
+ -
16
+
17
+ ### 不包含范围
18
+
19
+ -
20
+
21
+ ## 初步技术方案
22
+
23
+ <!-- 描述技术选型、架构思路、关键决策 -->
24
+
25
+ ## 成功标准
26
+
27
+ <!-- 定义项目成功的可衡量标准 -->
28
+
29
+ ## 风险与约束
30
+
31
+ <!-- 识别已知风险和约束条件 -->
32
+
33
+ ## 时间线
34
+
35
+ <!-- 粗略的时间估算和里程碑 -->
@@ -0,0 +1,39 @@
1
+ # 任务分解
2
+
3
+ > 基于设计:{design_link}
4
+
5
+ ## 任务列表
6
+
7
+ ### 阶段 1: {阶段名称}
8
+
9
+ - [ ] **TASK-001**: {任务标题}
10
+ - 描述:
11
+ - 涉及文件:
12
+ - 预估工时:
13
+ - 依赖任务:
14
+
15
+ - [ ] **TASK-002**: {任务标题}
16
+ - 描述:
17
+ - 涉及文件:
18
+ - 预估工时:
19
+ - 依赖任务:TASK-001
20
+
21
+ ### 阶段 2: {阶段名称}
22
+
23
+ - [ ] **TASK-003**: {任务标题}
24
+ - 描述:
25
+ - 涉及文件:
26
+ - 预估工时:
27
+ - 依赖任务:
28
+
29
+ ## 执行顺序
30
+
31
+ <!-- 任务间的依赖关系和推荐执行顺序 -->
32
+
33
+ ## 风险任务
34
+
35
+ <!-- 标注高风险的复杂任务 -->
36
+
37
+ ## 预估总工时
38
+
39
+ <!-- 汇总所有任务的预估工时 -->
@@ -0,0 +1,70 @@
1
+ /**
2
+ * 补丁:修复 @inquirer/core 在 Node.js 20 下的兼容性问题
3
+ *
4
+ * @inquirer/core@11.1.0+ 使用了 Node.js 22+ 的 `styleText` API(from 'node:util'),
5
+ * 在 Node.js 20 下报错 "styleText is not exported from node:util"。
6
+ *
7
+ * 方案:将 `import { styleText } from 'node:util'` 替换为
8
+ * 局部定义的等效函数,保留所有调用点不变。
9
+ */
10
+ import { readFileSync, writeFileSync, existsSync } from 'node:fs';
11
+ import { resolve, dirname } from 'node:path';
12
+ import { fileURLToPath } from 'node:url';
13
+
14
+ const __dirname = dirname(fileURLToPath(import.meta.url));
15
+ const rootDir = resolve(__dirname, '..');
16
+
17
+ const files = [
18
+ resolve(rootDir, 'node_modules/@inquirer/core/dist/lib/Separator.js'),
19
+ resolve(rootDir, 'node_modules/@inquirer/core/dist/lib/theme.js'),
20
+ ];
21
+
22
+ // ANSI 颜色名称到转义码的映射
23
+ const ANSI_CODES = { bold: 1, dim: 2, red: 31, green: 32, yellow: 33, blue: 34, magenta: 35, cyan: 36, white: 37 };
24
+
25
+ /** 生成 styleText 的替换函数源码 */
26
+ function generateStyleTextFn() {
27
+ const codeMap = JSON.stringify(ANSI_CODES);
28
+ return `const styleText = (fmt, txt) => { const c = ${codeMap}[fmt]; return c ? \`\\x1b[\${c}m\${txt}\\x1b[0m\` : txt; };`;
29
+ }
30
+
31
+ function patchFile(filePath) {
32
+ if (!existsSync(filePath)) {
33
+ console.error(`[patch-inquirer] 文件不存在,跳过: ${filePath}`);
34
+ return false;
35
+ }
36
+
37
+ let content = readFileSync(filePath, 'utf-8');
38
+ const original = content;
39
+
40
+ // 替换: import { styleText } from 'node:util' → 局部函数定义
41
+ const importRegex = /import\s*\{[^}]*\bstyleText\b[^}]*\}\s*from\s*['"]node:util['"];?\s*/;
42
+ if (!importRegex.test(content)) {
43
+ console.log(`[patch-inquirer] 未找到 styleText 导入,跳过: ${filePath}`);
44
+ return false;
45
+ }
46
+
47
+ // 检查是否已经有我们的补丁(幂等保护)
48
+ if (content.includes('// patched by openfeel')) {
49
+ console.log(`[patch-inquirer] 已修补,跳过: ${filePath}`);
50
+ return false;
51
+ }
52
+
53
+ content = content.replace(importRegex, generateStyleTextFn() + '\n// patched by openfeel\n');
54
+
55
+ if (content === original) {
56
+ console.log(`[patch-inquirer] 无需修改: ${filePath}`);
57
+ return false;
58
+ }
59
+
60
+ writeFileSync(filePath, content, 'utf-8');
61
+ console.log(`[patch-inquirer] ✅ 已修补: ${filePath}`);
62
+ return true;
63
+ }
64
+
65
+ // 执行
66
+ let count = 0;
67
+ for (const f of files) {
68
+ if (patchFile(f)) count++;
69
+ }
70
+ console.log(`[patch-inquirer] 完成: ${count} 个文件已修补`);