openspec-cn 0.23.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 (235) hide show
  1. package/LICENSE +22 -0
  2. package/README.md +153 -0
  3. package/bin/openspec.js +3 -0
  4. package/dist/cli/index.d.ts +2 -0
  5. package/dist/cli/index.js +480 -0
  6. package/dist/commands/change.d.ts +35 -0
  7. package/dist/commands/change.js +277 -0
  8. package/dist/commands/completion.d.ts +72 -0
  9. package/dist/commands/completion.js +257 -0
  10. package/dist/commands/config.d.ts +8 -0
  11. package/dist/commands/config.js +198 -0
  12. package/dist/commands/feedback.d.ts +9 -0
  13. package/dist/commands/feedback.js +183 -0
  14. package/dist/commands/schema.d.ts +6 -0
  15. package/dist/commands/schema.js +869 -0
  16. package/dist/commands/show.d.ts +14 -0
  17. package/dist/commands/show.js +132 -0
  18. package/dist/commands/spec.d.ts +15 -0
  19. package/dist/commands/spec.js +225 -0
  20. package/dist/commands/validate.d.ts +24 -0
  21. package/dist/commands/validate.js +294 -0
  22. package/dist/commands/workflow/index.d.ts +17 -0
  23. package/dist/commands/workflow/index.js +12 -0
  24. package/dist/commands/workflow/instructions.d.ts +29 -0
  25. package/dist/commands/workflow/instructions.js +381 -0
  26. package/dist/commands/workflow/new-change.d.ts +11 -0
  27. package/dist/commands/workflow/new-change.js +44 -0
  28. package/dist/commands/workflow/schemas.d.ts +10 -0
  29. package/dist/commands/workflow/schemas.js +34 -0
  30. package/dist/commands/workflow/shared.d.ts +52 -0
  31. package/dist/commands/workflow/shared.js +111 -0
  32. package/dist/commands/workflow/status.d.ts +14 -0
  33. package/dist/commands/workflow/status.js +58 -0
  34. package/dist/commands/workflow/templates.d.ts +16 -0
  35. package/dist/commands/workflow/templates.js +68 -0
  36. package/dist/core/archive.d.ts +11 -0
  37. package/dist/core/archive.js +280 -0
  38. package/dist/core/artifact-graph/graph.d.ts +56 -0
  39. package/dist/core/artifact-graph/graph.js +141 -0
  40. package/dist/core/artifact-graph/index.d.ts +7 -0
  41. package/dist/core/artifact-graph/index.js +13 -0
  42. package/dist/core/artifact-graph/instruction-loader.d.ts +143 -0
  43. package/dist/core/artifact-graph/instruction-loader.js +214 -0
  44. package/dist/core/artifact-graph/resolver.d.ts +81 -0
  45. package/dist/core/artifact-graph/resolver.js +257 -0
  46. package/dist/core/artifact-graph/schema.d.ts +13 -0
  47. package/dist/core/artifact-graph/schema.js +108 -0
  48. package/dist/core/artifact-graph/state.d.ts +12 -0
  49. package/dist/core/artifact-graph/state.js +54 -0
  50. package/dist/core/artifact-graph/types.d.ts +45 -0
  51. package/dist/core/artifact-graph/types.js +43 -0
  52. package/dist/core/command-generation/adapters/amazon-q.d.ts +13 -0
  53. package/dist/core/command-generation/adapters/amazon-q.js +26 -0
  54. package/dist/core/command-generation/adapters/antigravity.d.ts +13 -0
  55. package/dist/core/command-generation/adapters/antigravity.js +26 -0
  56. package/dist/core/command-generation/adapters/auggie.d.ts +13 -0
  57. package/dist/core/command-generation/adapters/auggie.js +27 -0
  58. package/dist/core/command-generation/adapters/claude.d.ts +13 -0
  59. package/dist/core/command-generation/adapters/claude.js +50 -0
  60. package/dist/core/command-generation/adapters/cline.d.ts +14 -0
  61. package/dist/core/command-generation/adapters/cline.js +27 -0
  62. package/dist/core/command-generation/adapters/codebuddy.d.ts +13 -0
  63. package/dist/core/command-generation/adapters/codebuddy.js +28 -0
  64. package/dist/core/command-generation/adapters/codex.d.ts +13 -0
  65. package/dist/core/command-generation/adapters/codex.js +27 -0
  66. package/dist/core/command-generation/adapters/continue.d.ts +13 -0
  67. package/dist/core/command-generation/adapters/continue.js +28 -0
  68. package/dist/core/command-generation/adapters/costrict.d.ts +13 -0
  69. package/dist/core/command-generation/adapters/costrict.js +27 -0
  70. package/dist/core/command-generation/adapters/crush.d.ts +13 -0
  71. package/dist/core/command-generation/adapters/crush.js +30 -0
  72. package/dist/core/command-generation/adapters/cursor.d.ts +14 -0
  73. package/dist/core/command-generation/adapters/cursor.js +44 -0
  74. package/dist/core/command-generation/adapters/factory.d.ts +13 -0
  75. package/dist/core/command-generation/adapters/factory.js +27 -0
  76. package/dist/core/command-generation/adapters/gemini.d.ts +13 -0
  77. package/dist/core/command-generation/adapters/gemini.js +26 -0
  78. package/dist/core/command-generation/adapters/github-copilot.d.ts +13 -0
  79. package/dist/core/command-generation/adapters/github-copilot.js +26 -0
  80. package/dist/core/command-generation/adapters/iflow.d.ts +13 -0
  81. package/dist/core/command-generation/adapters/iflow.js +29 -0
  82. package/dist/core/command-generation/adapters/index.d.ts +27 -0
  83. package/dist/core/command-generation/adapters/index.js +27 -0
  84. package/dist/core/command-generation/adapters/kilocode.d.ts +14 -0
  85. package/dist/core/command-generation/adapters/kilocode.js +23 -0
  86. package/dist/core/command-generation/adapters/opencode.d.ts +13 -0
  87. package/dist/core/command-generation/adapters/opencode.js +26 -0
  88. package/dist/core/command-generation/adapters/qoder.d.ts +13 -0
  89. package/dist/core/command-generation/adapters/qoder.js +30 -0
  90. package/dist/core/command-generation/adapters/qwen.d.ts +13 -0
  91. package/dist/core/command-generation/adapters/qwen.js +26 -0
  92. package/dist/core/command-generation/adapters/roocode.d.ts +14 -0
  93. package/dist/core/command-generation/adapters/roocode.js +27 -0
  94. package/dist/core/command-generation/adapters/windsurf.d.ts +14 -0
  95. package/dist/core/command-generation/adapters/windsurf.js +51 -0
  96. package/dist/core/command-generation/generator.d.ts +21 -0
  97. package/dist/core/command-generation/generator.js +27 -0
  98. package/dist/core/command-generation/index.d.ts +22 -0
  99. package/dist/core/command-generation/index.js +24 -0
  100. package/dist/core/command-generation/registry.d.ts +36 -0
  101. package/dist/core/command-generation/registry.js +88 -0
  102. package/dist/core/command-generation/types.d.ts +55 -0
  103. package/dist/core/command-generation/types.js +8 -0
  104. package/dist/core/completions/command-registry.d.ts +7 -0
  105. package/dist/core/completions/command-registry.js +456 -0
  106. package/dist/core/completions/completion-provider.d.ts +60 -0
  107. package/dist/core/completions/completion-provider.js +102 -0
  108. package/dist/core/completions/factory.d.ts +64 -0
  109. package/dist/core/completions/factory.js +75 -0
  110. package/dist/core/completions/generators/bash-generator.d.ts +32 -0
  111. package/dist/core/completions/generators/bash-generator.js +174 -0
  112. package/dist/core/completions/generators/fish-generator.d.ts +32 -0
  113. package/dist/core/completions/generators/fish-generator.js +157 -0
  114. package/dist/core/completions/generators/powershell-generator.d.ts +33 -0
  115. package/dist/core/completions/generators/powershell-generator.js +207 -0
  116. package/dist/core/completions/generators/zsh-generator.d.ts +44 -0
  117. package/dist/core/completions/generators/zsh-generator.js +250 -0
  118. package/dist/core/completions/installers/bash-installer.d.ts +87 -0
  119. package/dist/core/completions/installers/bash-installer.js +318 -0
  120. package/dist/core/completions/installers/fish-installer.d.ts +43 -0
  121. package/dist/core/completions/installers/fish-installer.js +143 -0
  122. package/dist/core/completions/installers/powershell-installer.d.ts +88 -0
  123. package/dist/core/completions/installers/powershell-installer.js +327 -0
  124. package/dist/core/completions/installers/zsh-installer.d.ts +125 -0
  125. package/dist/core/completions/installers/zsh-installer.js +449 -0
  126. package/dist/core/completions/templates/bash-templates.d.ts +6 -0
  127. package/dist/core/completions/templates/bash-templates.js +24 -0
  128. package/dist/core/completions/templates/fish-templates.d.ts +7 -0
  129. package/dist/core/completions/templates/fish-templates.js +39 -0
  130. package/dist/core/completions/templates/powershell-templates.d.ts +6 -0
  131. package/dist/core/completions/templates/powershell-templates.js +25 -0
  132. package/dist/core/completions/templates/zsh-templates.d.ts +6 -0
  133. package/dist/core/completions/templates/zsh-templates.js +36 -0
  134. package/dist/core/completions/types.d.ts +79 -0
  135. package/dist/core/completions/types.js +2 -0
  136. package/dist/core/config-prompts.d.ts +9 -0
  137. package/dist/core/config-prompts.js +34 -0
  138. package/dist/core/config-schema.d.ts +76 -0
  139. package/dist/core/config-schema.js +200 -0
  140. package/dist/core/config.d.ts +17 -0
  141. package/dist/core/config.js +30 -0
  142. package/dist/core/converters/json-converter.d.ts +6 -0
  143. package/dist/core/converters/json-converter.js +51 -0
  144. package/dist/core/global-config.d.ts +39 -0
  145. package/dist/core/global-config.js +115 -0
  146. package/dist/core/index.d.ts +2 -0
  147. package/dist/core/index.js +3 -0
  148. package/dist/core/init.d.ts +32 -0
  149. package/dist/core/init.js +433 -0
  150. package/dist/core/legacy-cleanup.d.ts +162 -0
  151. package/dist/core/legacy-cleanup.js +501 -0
  152. package/dist/core/list.d.ts +9 -0
  153. package/dist/core/list.js +171 -0
  154. package/dist/core/parsers/change-parser.d.ts +13 -0
  155. package/dist/core/parsers/change-parser.js +193 -0
  156. package/dist/core/parsers/markdown-parser.d.ts +22 -0
  157. package/dist/core/parsers/markdown-parser.js +187 -0
  158. package/dist/core/parsers/requirement-blocks.d.ts +37 -0
  159. package/dist/core/parsers/requirement-blocks.js +201 -0
  160. package/dist/core/project-config.d.ts +64 -0
  161. package/dist/core/project-config.js +223 -0
  162. package/dist/core/schemas/base.schema.d.ts +13 -0
  163. package/dist/core/schemas/base.schema.js +13 -0
  164. package/dist/core/schemas/change.schema.d.ts +73 -0
  165. package/dist/core/schemas/change.schema.js +31 -0
  166. package/dist/core/schemas/index.d.ts +4 -0
  167. package/dist/core/schemas/index.js +4 -0
  168. package/dist/core/schemas/spec.schema.d.ts +18 -0
  169. package/dist/core/schemas/spec.schema.js +15 -0
  170. package/dist/core/shared/index.d.ts +8 -0
  171. package/dist/core/shared/index.js +8 -0
  172. package/dist/core/shared/skill-generation.d.ts +41 -0
  173. package/dist/core/shared/skill-generation.js +74 -0
  174. package/dist/core/shared/tool-detection.d.ts +66 -0
  175. package/dist/core/shared/tool-detection.js +140 -0
  176. package/dist/core/specs-apply.d.ts +73 -0
  177. package/dist/core/specs-apply.js +384 -0
  178. package/dist/core/styles/palette.d.ts +7 -0
  179. package/dist/core/styles/palette.js +8 -0
  180. package/dist/core/templates/index.d.ts +8 -0
  181. package/dist/core/templates/index.js +9 -0
  182. package/dist/core/templates/skill-templates.d.ts +112 -0
  183. package/dist/core/templates/skill-templates.js +2893 -0
  184. package/dist/core/update.d.ts +42 -0
  185. package/dist/core/update.js +306 -0
  186. package/dist/core/validation/constants.d.ts +34 -0
  187. package/dist/core/validation/constants.js +40 -0
  188. package/dist/core/validation/types.d.ts +18 -0
  189. package/dist/core/validation/types.js +2 -0
  190. package/dist/core/validation/validator.d.ts +33 -0
  191. package/dist/core/validation/validator.js +409 -0
  192. package/dist/core/view.d.ts +8 -0
  193. package/dist/core/view.js +168 -0
  194. package/dist/index.d.ts +3 -0
  195. package/dist/index.js +3 -0
  196. package/dist/prompts/searchable-multi-select.d.ts +27 -0
  197. package/dist/prompts/searchable-multi-select.js +149 -0
  198. package/dist/telemetry/config.d.ts +32 -0
  199. package/dist/telemetry/config.js +68 -0
  200. package/dist/telemetry/index.d.ts +31 -0
  201. package/dist/telemetry/index.js +145 -0
  202. package/dist/ui/ascii-patterns.d.ts +16 -0
  203. package/dist/ui/ascii-patterns.js +133 -0
  204. package/dist/ui/welcome-screen.d.ts +10 -0
  205. package/dist/ui/welcome-screen.js +146 -0
  206. package/dist/utils/change-metadata.d.ts +51 -0
  207. package/dist/utils/change-metadata.js +147 -0
  208. package/dist/utils/change-utils.d.ts +62 -0
  209. package/dist/utils/change-utils.js +121 -0
  210. package/dist/utils/file-system.d.ts +36 -0
  211. package/dist/utils/file-system.js +281 -0
  212. package/dist/utils/index.d.ts +5 -0
  213. package/dist/utils/index.js +7 -0
  214. package/dist/utils/interactive.d.ts +18 -0
  215. package/dist/utils/interactive.js +21 -0
  216. package/dist/utils/item-discovery.d.ts +4 -0
  217. package/dist/utils/item-discovery.js +72 -0
  218. package/dist/utils/match.d.ts +3 -0
  219. package/dist/utils/match.js +22 -0
  220. package/dist/utils/shell-detection.d.ts +20 -0
  221. package/dist/utils/shell-detection.js +41 -0
  222. package/dist/utils/task-progress.d.ts +8 -0
  223. package/dist/utils/task-progress.js +36 -0
  224. package/package.json +84 -0
  225. package/schemas/spec-driven/schema.yaml +148 -0
  226. package/schemas/spec-driven/templates/design.md +19 -0
  227. package/schemas/spec-driven/templates/proposal.md +23 -0
  228. package/schemas/spec-driven/templates/spec.md +8 -0
  229. package/schemas/spec-driven/templates/tasks.md +9 -0
  230. package/schemas/tdd/schema.yaml +213 -0
  231. package/schemas/tdd/templates/docs.md +15 -0
  232. package/schemas/tdd/templates/implementation.md +11 -0
  233. package/schemas/tdd/templates/spec.md +11 -0
  234. package/schemas/tdd/templates/test.md +11 -0
  235. package/scripts/postinstall.js +147 -0
@@ -0,0 +1,143 @@
1
+ import { ArtifactGraph } from './graph.js';
2
+ import type { CompletedSet } from './types.js';
3
+ /**
4
+ * Error thrown when loading a template fails.
5
+ */
6
+ export declare class TemplateLoadError extends Error {
7
+ readonly templatePath: string;
8
+ constructor(message: string, templatePath: string);
9
+ }
10
+ /**
11
+ * Change context containing graph, completion state, and metadata.
12
+ */
13
+ export interface ChangeContext {
14
+ /** The artifact dependency graph */
15
+ graph: ArtifactGraph;
16
+ /** Set of completed artifact IDs */
17
+ completed: CompletedSet;
18
+ /** Schema name being used */
19
+ schemaName: string;
20
+ /** Change name */
21
+ changeName: string;
22
+ /** Path to the change directory */
23
+ changeDir: string;
24
+ /** Project root directory */
25
+ projectRoot: string;
26
+ }
27
+ /**
28
+ * Enriched instructions for creating an artifact.
29
+ */
30
+ export interface ArtifactInstructions {
31
+ /** Change name */
32
+ changeName: string;
33
+ /** Artifact ID */
34
+ artifactId: string;
35
+ /** Schema name */
36
+ schemaName: string;
37
+ /** Full path to change directory */
38
+ changeDir: string;
39
+ /** Output path pattern (e.g., "proposal.md") */
40
+ outputPath: string;
41
+ /** Artifact description */
42
+ description: string;
43
+ /** Guidance on how to create this artifact (from schema instruction field) */
44
+ instruction: string | undefined;
45
+ /** Project context from config (constraints/background for AI, not to be included in output) */
46
+ context: string | undefined;
47
+ /** Artifact-specific rules from config (constraints for AI, not to be included in output) */
48
+ rules: string[] | undefined;
49
+ /** Template content (structure to follow - this IS the output format) */
50
+ template: string;
51
+ /** Dependencies with completion status and paths */
52
+ dependencies: DependencyInfo[];
53
+ /** Artifacts that become available after completing this one */
54
+ unlocks: string[];
55
+ }
56
+ /**
57
+ * Dependency information including path and description.
58
+ */
59
+ export interface DependencyInfo {
60
+ /** Artifact ID */
61
+ id: string;
62
+ /** Whether the dependency is completed */
63
+ done: boolean;
64
+ /** Relative output path of the dependency (e.g., "proposal.md") */
65
+ path: string;
66
+ /** Description of the dependency artifact */
67
+ description: string;
68
+ }
69
+ /**
70
+ * Status of a single artifact in the workflow.
71
+ */
72
+ export interface ArtifactStatus {
73
+ /** Artifact ID */
74
+ id: string;
75
+ /** Output path pattern */
76
+ outputPath: string;
77
+ /** Status: done, ready, or blocked */
78
+ status: 'done' | 'ready' | 'blocked';
79
+ /** Missing dependencies (only for blocked) */
80
+ missingDeps?: string[];
81
+ }
82
+ /**
83
+ * Formatted change status.
84
+ */
85
+ export interface ChangeStatus {
86
+ /** Change name */
87
+ changeName: string;
88
+ /** Schema name */
89
+ schemaName: string;
90
+ /** Whether all artifacts are complete */
91
+ isComplete: boolean;
92
+ /** Artifact IDs required before apply phase (from schema's apply.requires) */
93
+ applyRequires: string[];
94
+ /** Status of each artifact */
95
+ artifacts: ArtifactStatus[];
96
+ }
97
+ /**
98
+ * Loads a template from a schema's templates directory.
99
+ *
100
+ * @param schemaName - Schema name (e.g., "spec-driven")
101
+ * @param templatePath - Relative path within the templates directory (e.g., "proposal.md")
102
+ * @param projectRoot - Optional project root for project-local schema resolution
103
+ * @returns The template content
104
+ * @throws TemplateLoadError if the template cannot be loaded
105
+ */
106
+ export declare function loadTemplate(schemaName: string, templatePath: string, projectRoot?: string): string;
107
+ /**
108
+ * Loads change context combining graph and completion state.
109
+ *
110
+ * Schema resolution order:
111
+ * 1. Explicit schemaName parameter (if provided)
112
+ * 2. Schema from .openspec.yaml metadata (if exists in change directory)
113
+ * 3. Default 'spec-driven'
114
+ *
115
+ * @param projectRoot - Project root directory
116
+ * @param changeName - Change name
117
+ * @param schemaName - Optional schema name override. If not provided, auto-detected from metadata.
118
+ * @returns Change context with graph, completed set, and metadata
119
+ */
120
+ export declare function loadChangeContext(projectRoot: string, changeName: string, schemaName?: string): ChangeContext;
121
+ /**
122
+ * Generates enriched instructions for creating an artifact.
123
+ *
124
+ * Instruction injection order:
125
+ * 1. <context> - Project context from config (if present)
126
+ * 2. <rules> - Artifact-specific rules from config (if present)
127
+ * 3. <template> - Schema's template content
128
+ *
129
+ * @param context - Change context
130
+ * @param artifactId - Artifact ID to generate instructions for
131
+ * @param projectRoot - Project root directory (for reading config)
132
+ * @returns Enriched artifact instructions
133
+ * @throws Error if artifact not found
134
+ */
135
+ export declare function generateInstructions(context: ChangeContext, artifactId: string, projectRoot?: string): ArtifactInstructions;
136
+ /**
137
+ * Formats the status of all artifacts in a change.
138
+ *
139
+ * @param context - Change context
140
+ * @returns Formatted change status
141
+ */
142
+ export declare function formatChangeStatus(context: ChangeContext): ChangeStatus;
143
+ //# sourceMappingURL=instruction-loader.d.ts.map
@@ -0,0 +1,214 @@
1
+ import * as fs from 'node:fs';
2
+ import * as path from 'node:path';
3
+ import { getSchemaDir, resolveSchema } from './resolver.js';
4
+ import { ArtifactGraph } from './graph.js';
5
+ import { detectCompleted } from './state.js';
6
+ import { resolveSchemaForChange } from '../../utils/change-metadata.js';
7
+ import { readProjectConfig, validateConfigRules } from '../project-config.js';
8
+ // Session-level cache for validation warnings (avoid repeating same warnings)
9
+ const shownWarnings = new Set();
10
+ /**
11
+ * Error thrown when loading a template fails.
12
+ */
13
+ export class TemplateLoadError extends Error {
14
+ templatePath;
15
+ constructor(message, templatePath) {
16
+ super(message);
17
+ this.templatePath = templatePath;
18
+ this.name = 'TemplateLoadError';
19
+ }
20
+ }
21
+ /**
22
+ * Loads a template from a schema's templates directory.
23
+ *
24
+ * @param schemaName - Schema name (e.g., "spec-driven")
25
+ * @param templatePath - Relative path within the templates directory (e.g., "proposal.md")
26
+ * @param projectRoot - Optional project root for project-local schema resolution
27
+ * @returns The template content
28
+ * @throws TemplateLoadError if the template cannot be loaded
29
+ */
30
+ export function loadTemplate(schemaName, templatePath, projectRoot) {
31
+ const schemaDir = getSchemaDir(schemaName, projectRoot);
32
+ if (!schemaDir) {
33
+ throw new TemplateLoadError(`Schema '${schemaName}' not found`, templatePath);
34
+ }
35
+ const fullPath = path.join(schemaDir, 'templates', templatePath);
36
+ if (!fs.existsSync(fullPath)) {
37
+ throw new TemplateLoadError(`Template not found: ${fullPath}`, fullPath);
38
+ }
39
+ try {
40
+ return fs.readFileSync(fullPath, 'utf-8');
41
+ }
42
+ catch (err) {
43
+ const ioError = err instanceof Error ? err : new Error(String(err));
44
+ throw new TemplateLoadError(`Failed to read template: ${ioError.message}`, fullPath);
45
+ }
46
+ }
47
+ /**
48
+ * Loads change context combining graph and completion state.
49
+ *
50
+ * Schema resolution order:
51
+ * 1. Explicit schemaName parameter (if provided)
52
+ * 2. Schema from .openspec.yaml metadata (if exists in change directory)
53
+ * 3. Default 'spec-driven'
54
+ *
55
+ * @param projectRoot - Project root directory
56
+ * @param changeName - Change name
57
+ * @param schemaName - Optional schema name override. If not provided, auto-detected from metadata.
58
+ * @returns Change context with graph, completed set, and metadata
59
+ */
60
+ export function loadChangeContext(projectRoot, changeName, schemaName) {
61
+ const changeDir = path.join(projectRoot, 'openspec', 'changes', changeName);
62
+ // Resolve schema: explicit > metadata > default
63
+ const resolvedSchemaName = resolveSchemaForChange(changeDir, schemaName);
64
+ const schema = resolveSchema(resolvedSchemaName, projectRoot);
65
+ const graph = ArtifactGraph.fromSchema(schema);
66
+ const completed = detectCompleted(graph, changeDir);
67
+ return {
68
+ graph,
69
+ completed,
70
+ schemaName: resolvedSchemaName,
71
+ changeName,
72
+ changeDir,
73
+ projectRoot,
74
+ };
75
+ }
76
+ /**
77
+ * Generates enriched instructions for creating an artifact.
78
+ *
79
+ * Instruction injection order:
80
+ * 1. <context> - Project context from config (if present)
81
+ * 2. <rules> - Artifact-specific rules from config (if present)
82
+ * 3. <template> - Schema's template content
83
+ *
84
+ * @param context - Change context
85
+ * @param artifactId - Artifact ID to generate instructions for
86
+ * @param projectRoot - Project root directory (for reading config)
87
+ * @returns Enriched artifact instructions
88
+ * @throws Error if artifact not found
89
+ */
90
+ export function generateInstructions(context, artifactId, projectRoot) {
91
+ const artifact = context.graph.getArtifact(artifactId);
92
+ if (!artifact) {
93
+ throw new Error(`Artifact '${artifactId}' not found in schema '${context.schemaName}'`);
94
+ }
95
+ const templateContent = loadTemplate(context.schemaName, artifact.template, context.projectRoot);
96
+ const dependencies = getDependencyInfo(artifact, context.graph, context.completed);
97
+ const unlocks = getUnlockedArtifacts(context.graph, artifactId);
98
+ // Use projectRoot from context if not explicitly provided
99
+ const effectiveProjectRoot = projectRoot ?? context.projectRoot;
100
+ // Try to read project config for context and rules
101
+ let projectConfig = null;
102
+ if (effectiveProjectRoot) {
103
+ try {
104
+ projectConfig = readProjectConfig(effectiveProjectRoot);
105
+ }
106
+ catch {
107
+ // If config read fails, continue without config
108
+ }
109
+ }
110
+ // Validate rules artifact IDs if config has rules (only once per session)
111
+ if (projectConfig?.rules) {
112
+ const validArtifactIds = new Set(context.graph.getAllArtifacts().map((a) => a.id));
113
+ const warnings = validateConfigRules(projectConfig.rules, validArtifactIds, context.schemaName);
114
+ // Show each unique warning only once per session
115
+ for (const warning of warnings) {
116
+ if (!shownWarnings.has(warning)) {
117
+ console.warn(warning);
118
+ shownWarnings.add(warning);
119
+ }
120
+ }
121
+ }
122
+ // Extract context and rules as separate fields (not prepended to template)
123
+ const configContext = projectConfig?.context?.trim() || undefined;
124
+ const rulesForArtifact = projectConfig?.rules?.[artifactId];
125
+ const configRules = rulesForArtifact && rulesForArtifact.length > 0 ? rulesForArtifact : undefined;
126
+ return {
127
+ changeName: context.changeName,
128
+ artifactId: artifact.id,
129
+ schemaName: context.schemaName,
130
+ changeDir: context.changeDir,
131
+ outputPath: artifact.generates,
132
+ description: artifact.description,
133
+ instruction: artifact.instruction,
134
+ context: configContext,
135
+ rules: configRules,
136
+ template: templateContent,
137
+ dependencies,
138
+ unlocks,
139
+ };
140
+ }
141
+ /**
142
+ * Gets dependency info including paths and descriptions.
143
+ */
144
+ function getDependencyInfo(artifact, graph, completed) {
145
+ return artifact.requires.map(id => {
146
+ const depArtifact = graph.getArtifact(id);
147
+ return {
148
+ id,
149
+ done: completed.has(id),
150
+ path: depArtifact?.generates ?? id,
151
+ description: depArtifact?.description ?? '',
152
+ };
153
+ });
154
+ }
155
+ /**
156
+ * Gets artifacts that become available after completing the given artifact.
157
+ */
158
+ function getUnlockedArtifacts(graph, artifactId) {
159
+ const unlocks = [];
160
+ for (const artifact of graph.getAllArtifacts()) {
161
+ if (artifact.requires.includes(artifactId)) {
162
+ unlocks.push(artifact.id);
163
+ }
164
+ }
165
+ return unlocks.sort();
166
+ }
167
+ /**
168
+ * Formats the status of all artifacts in a change.
169
+ *
170
+ * @param context - Change context
171
+ * @returns Formatted change status
172
+ */
173
+ export function formatChangeStatus(context) {
174
+ // Load schema to get apply phase configuration
175
+ const schema = resolveSchema(context.schemaName, context.projectRoot);
176
+ const applyRequires = schema.apply?.requires ?? schema.artifacts.map(a => a.id);
177
+ const artifacts = context.graph.getAllArtifacts();
178
+ const ready = new Set(context.graph.getNextArtifacts(context.completed));
179
+ const blocked = context.graph.getBlocked(context.completed);
180
+ const artifactStatuses = artifacts.map(artifact => {
181
+ if (context.completed.has(artifact.id)) {
182
+ return {
183
+ id: artifact.id,
184
+ outputPath: artifact.generates,
185
+ status: 'done',
186
+ };
187
+ }
188
+ if (ready.has(artifact.id)) {
189
+ return {
190
+ id: artifact.id,
191
+ outputPath: artifact.generates,
192
+ status: 'ready',
193
+ };
194
+ }
195
+ return {
196
+ id: artifact.id,
197
+ outputPath: artifact.generates,
198
+ status: 'blocked',
199
+ missingDeps: blocked[artifact.id] ?? [],
200
+ };
201
+ });
202
+ // Sort by build order for consistent output
203
+ const buildOrder = context.graph.getBuildOrder();
204
+ const orderMap = new Map(buildOrder.map((id, idx) => [id, idx]));
205
+ artifactStatuses.sort((a, b) => (orderMap.get(a.id) ?? 0) - (orderMap.get(b.id) ?? 0));
206
+ return {
207
+ changeName: context.changeName,
208
+ schemaName: context.schemaName,
209
+ isComplete: context.graph.isComplete(context.completed),
210
+ applyRequires,
211
+ artifacts: artifactStatuses,
212
+ };
213
+ }
214
+ //# sourceMappingURL=instruction-loader.js.map
@@ -0,0 +1,81 @@
1
+ import type { SchemaYaml } from './types.js';
2
+ /**
3
+ * Error thrown when loading a schema fails.
4
+ */
5
+ export declare class SchemaLoadError extends Error {
6
+ readonly schemaPath: string;
7
+ readonly cause?: Error | undefined;
8
+ constructor(message: string, schemaPath: string, cause?: Error | undefined);
9
+ }
10
+ /**
11
+ * Gets the package's built-in schemas directory path.
12
+ * Uses import.meta.url to resolve relative to the current module.
13
+ */
14
+ export declare function getPackageSchemasDir(): string;
15
+ /**
16
+ * Gets the user's schema override directory path.
17
+ */
18
+ export declare function getUserSchemasDir(): string;
19
+ /**
20
+ * Gets the project-local schemas directory path.
21
+ * @param projectRoot - The project root directory
22
+ * @returns The path to the project's schemas directory
23
+ */
24
+ export declare function getProjectSchemasDir(projectRoot: string): string;
25
+ /**
26
+ * Resolves a schema name to its directory path.
27
+ *
28
+ * Resolution order (when projectRoot is provided):
29
+ * 1. Project-local: <projectRoot>/openspec/schemas/<name>/schema.yaml
30
+ * 2. User override: ${XDG_DATA_HOME}/openspec/schemas/<name>/schema.yaml
31
+ * 3. Package built-in: <package>/schemas/<name>/schema.yaml
32
+ *
33
+ * When projectRoot is not provided, only user override and package built-in are checked
34
+ * (backward compatible behavior).
35
+ *
36
+ * @param name - Schema name (e.g., "spec-driven")
37
+ * @param projectRoot - Optional project root directory for project-local schema resolution
38
+ * @returns The path to the schema directory, or null if not found
39
+ */
40
+ export declare function getSchemaDir(name: string, projectRoot?: string): string | null;
41
+ /**
42
+ * Resolves a schema name to a SchemaYaml object.
43
+ *
44
+ * Resolution order (when projectRoot is provided):
45
+ * 1. Project-local: <projectRoot>/openspec/schemas/<name>/schema.yaml
46
+ * 2. User override: ${XDG_DATA_HOME}/openspec/schemas/<name>/schema.yaml
47
+ * 3. Package built-in: <package>/schemas/<name>/schema.yaml
48
+ *
49
+ * When projectRoot is not provided, only user override and package built-in are checked
50
+ * (backward compatible behavior).
51
+ *
52
+ * @param name - Schema name (e.g., "spec-driven")
53
+ * @param projectRoot - Optional project root directory for project-local schema resolution
54
+ * @returns The resolved schema object
55
+ * @throws Error if schema is not found in any location
56
+ */
57
+ export declare function resolveSchema(name: string, projectRoot?: string): SchemaYaml;
58
+ /**
59
+ * Lists all available schema names.
60
+ * Combines project-local, user override, and package built-in schemas.
61
+ *
62
+ * @param projectRoot - Optional project root directory for project-local schema resolution
63
+ */
64
+ export declare function listSchemas(projectRoot?: string): string[];
65
+ /**
66
+ * Schema info with metadata (name, description, artifacts).
67
+ */
68
+ export interface SchemaInfo {
69
+ name: string;
70
+ description: string;
71
+ artifacts: string[];
72
+ source: 'project' | 'user' | 'package';
73
+ }
74
+ /**
75
+ * Lists all available schemas with their descriptions and artifact lists.
76
+ * Useful for agent skills to present schema selection to users.
77
+ *
78
+ * @param projectRoot - Optional project root directory for project-local schema resolution
79
+ */
80
+ export declare function listSchemasWithInfo(projectRoot?: string): SchemaInfo[];
81
+ //# sourceMappingURL=resolver.d.ts.map
@@ -0,0 +1,257 @@
1
+ import * as fs from 'node:fs';
2
+ import * as path from 'node:path';
3
+ import { fileURLToPath } from 'node:url';
4
+ import { getGlobalDataDir } from '../global-config.js';
5
+ import { parseSchema, SchemaValidationError } from './schema.js';
6
+ /**
7
+ * Error thrown when loading a schema fails.
8
+ */
9
+ export class SchemaLoadError extends Error {
10
+ schemaPath;
11
+ cause;
12
+ constructor(message, schemaPath, cause) {
13
+ super(message);
14
+ this.schemaPath = schemaPath;
15
+ this.cause = cause;
16
+ this.name = 'SchemaLoadError';
17
+ }
18
+ }
19
+ /**
20
+ * Gets the package's built-in schemas directory path.
21
+ * Uses import.meta.url to resolve relative to the current module.
22
+ */
23
+ export function getPackageSchemasDir() {
24
+ const currentFile = fileURLToPath(import.meta.url);
25
+ // Navigate from dist/core/artifact-graph/ to package root's schemas/
26
+ return path.join(path.dirname(currentFile), '..', '..', '..', 'schemas');
27
+ }
28
+ /**
29
+ * Gets the user's schema override directory path.
30
+ */
31
+ export function getUserSchemasDir() {
32
+ return path.join(getGlobalDataDir(), 'schemas');
33
+ }
34
+ /**
35
+ * Gets the project-local schemas directory path.
36
+ * @param projectRoot - The project root directory
37
+ * @returns The path to the project's schemas directory
38
+ */
39
+ export function getProjectSchemasDir(projectRoot) {
40
+ return path.join(projectRoot, 'openspec', 'schemas');
41
+ }
42
+ /**
43
+ * Resolves a schema name to its directory path.
44
+ *
45
+ * Resolution order (when projectRoot is provided):
46
+ * 1. Project-local: <projectRoot>/openspec/schemas/<name>/schema.yaml
47
+ * 2. User override: ${XDG_DATA_HOME}/openspec/schemas/<name>/schema.yaml
48
+ * 3. Package built-in: <package>/schemas/<name>/schema.yaml
49
+ *
50
+ * When projectRoot is not provided, only user override and package built-in are checked
51
+ * (backward compatible behavior).
52
+ *
53
+ * @param name - Schema name (e.g., "spec-driven")
54
+ * @param projectRoot - Optional project root directory for project-local schema resolution
55
+ * @returns The path to the schema directory, or null if not found
56
+ */
57
+ export function getSchemaDir(name, projectRoot) {
58
+ // 1. Check project-local directory (if projectRoot provided)
59
+ if (projectRoot) {
60
+ const projectDir = path.join(getProjectSchemasDir(projectRoot), name);
61
+ const projectSchemaPath = path.join(projectDir, 'schema.yaml');
62
+ if (fs.existsSync(projectSchemaPath)) {
63
+ return projectDir;
64
+ }
65
+ }
66
+ // 2. Check user override directory
67
+ const userDir = path.join(getUserSchemasDir(), name);
68
+ const userSchemaPath = path.join(userDir, 'schema.yaml');
69
+ if (fs.existsSync(userSchemaPath)) {
70
+ return userDir;
71
+ }
72
+ // 3. Check package built-in directory
73
+ const packageDir = path.join(getPackageSchemasDir(), name);
74
+ const packageSchemaPath = path.join(packageDir, 'schema.yaml');
75
+ if (fs.existsSync(packageSchemaPath)) {
76
+ return packageDir;
77
+ }
78
+ return null;
79
+ }
80
+ /**
81
+ * Resolves a schema name to a SchemaYaml object.
82
+ *
83
+ * Resolution order (when projectRoot is provided):
84
+ * 1. Project-local: <projectRoot>/openspec/schemas/<name>/schema.yaml
85
+ * 2. User override: ${XDG_DATA_HOME}/openspec/schemas/<name>/schema.yaml
86
+ * 3. Package built-in: <package>/schemas/<name>/schema.yaml
87
+ *
88
+ * When projectRoot is not provided, only user override and package built-in are checked
89
+ * (backward compatible behavior).
90
+ *
91
+ * @param name - Schema name (e.g., "spec-driven")
92
+ * @param projectRoot - Optional project root directory for project-local schema resolution
93
+ * @returns The resolved schema object
94
+ * @throws Error if schema is not found in any location
95
+ */
96
+ export function resolveSchema(name, projectRoot) {
97
+ // Normalize name (remove .yaml extension if provided)
98
+ const normalizedName = name.replace(/\.ya?ml$/, '');
99
+ const schemaDir = getSchemaDir(normalizedName, projectRoot);
100
+ if (!schemaDir) {
101
+ const availableSchemas = listSchemas(projectRoot);
102
+ throw new Error(`Schema '${normalizedName}' not found. Available schemas: ${availableSchemas.join(', ')}`);
103
+ }
104
+ const schemaPath = path.join(schemaDir, 'schema.yaml');
105
+ // Load and parse the schema
106
+ let content;
107
+ try {
108
+ content = fs.readFileSync(schemaPath, 'utf-8');
109
+ }
110
+ catch (err) {
111
+ const ioError = err instanceof Error ? err : new Error(String(err));
112
+ throw new SchemaLoadError(`Failed to read schema at '${schemaPath}': ${ioError.message}`, schemaPath, ioError);
113
+ }
114
+ try {
115
+ return parseSchema(content);
116
+ }
117
+ catch (err) {
118
+ if (err instanceof SchemaValidationError) {
119
+ throw new SchemaLoadError(`Invalid schema at '${schemaPath}': ${err.message}`, schemaPath, err);
120
+ }
121
+ const parseError = err instanceof Error ? err : new Error(String(err));
122
+ throw new SchemaLoadError(`Failed to parse schema at '${schemaPath}': ${parseError.message}`, schemaPath, parseError);
123
+ }
124
+ }
125
+ /**
126
+ * Lists all available schema names.
127
+ * Combines project-local, user override, and package built-in schemas.
128
+ *
129
+ * @param projectRoot - Optional project root directory for project-local schema resolution
130
+ */
131
+ export function listSchemas(projectRoot) {
132
+ const schemas = new Set();
133
+ // Add package built-in schemas
134
+ const packageDir = getPackageSchemasDir();
135
+ if (fs.existsSync(packageDir)) {
136
+ for (const entry of fs.readdirSync(packageDir, { withFileTypes: true })) {
137
+ if (entry.isDirectory()) {
138
+ const schemaPath = path.join(packageDir, entry.name, 'schema.yaml');
139
+ if (fs.existsSync(schemaPath)) {
140
+ schemas.add(entry.name);
141
+ }
142
+ }
143
+ }
144
+ }
145
+ // Add user override schemas (may override package schemas)
146
+ const userDir = getUserSchemasDir();
147
+ if (fs.existsSync(userDir)) {
148
+ for (const entry of fs.readdirSync(userDir, { withFileTypes: true })) {
149
+ if (entry.isDirectory()) {
150
+ const schemaPath = path.join(userDir, entry.name, 'schema.yaml');
151
+ if (fs.existsSync(schemaPath)) {
152
+ schemas.add(entry.name);
153
+ }
154
+ }
155
+ }
156
+ }
157
+ // Add project-local schemas (if projectRoot provided)
158
+ if (projectRoot) {
159
+ const projectDir = getProjectSchemasDir(projectRoot);
160
+ if (fs.existsSync(projectDir)) {
161
+ for (const entry of fs.readdirSync(projectDir, { withFileTypes: true })) {
162
+ if (entry.isDirectory()) {
163
+ const schemaPath = path.join(projectDir, entry.name, 'schema.yaml');
164
+ if (fs.existsSync(schemaPath)) {
165
+ schemas.add(entry.name);
166
+ }
167
+ }
168
+ }
169
+ }
170
+ }
171
+ return Array.from(schemas).sort();
172
+ }
173
+ /**
174
+ * Lists all available schemas with their descriptions and artifact lists.
175
+ * Useful for agent skills to present schema selection to users.
176
+ *
177
+ * @param projectRoot - Optional project root directory for project-local schema resolution
178
+ */
179
+ export function listSchemasWithInfo(projectRoot) {
180
+ const schemas = [];
181
+ const seenNames = new Set();
182
+ // Add project-local schemas first (highest priority, if projectRoot provided)
183
+ if (projectRoot) {
184
+ const projectDir = getProjectSchemasDir(projectRoot);
185
+ if (fs.existsSync(projectDir)) {
186
+ for (const entry of fs.readdirSync(projectDir, { withFileTypes: true })) {
187
+ if (entry.isDirectory()) {
188
+ const schemaPath = path.join(projectDir, entry.name, 'schema.yaml');
189
+ if (fs.existsSync(schemaPath)) {
190
+ try {
191
+ const schema = parseSchema(fs.readFileSync(schemaPath, 'utf-8'));
192
+ schemas.push({
193
+ name: entry.name,
194
+ description: schema.description || '',
195
+ artifacts: schema.artifacts.map((a) => a.id),
196
+ source: 'project',
197
+ });
198
+ seenNames.add(entry.name);
199
+ }
200
+ catch {
201
+ // Skip invalid schemas
202
+ }
203
+ }
204
+ }
205
+ }
206
+ }
207
+ }
208
+ // Add user override schemas (if not overridden by project)
209
+ const userDir = getUserSchemasDir();
210
+ if (fs.existsSync(userDir)) {
211
+ for (const entry of fs.readdirSync(userDir, { withFileTypes: true })) {
212
+ if (entry.isDirectory() && !seenNames.has(entry.name)) {
213
+ const schemaPath = path.join(userDir, entry.name, 'schema.yaml');
214
+ if (fs.existsSync(schemaPath)) {
215
+ try {
216
+ const schema = parseSchema(fs.readFileSync(schemaPath, 'utf-8'));
217
+ schemas.push({
218
+ name: entry.name,
219
+ description: schema.description || '',
220
+ artifacts: schema.artifacts.map((a) => a.id),
221
+ source: 'user',
222
+ });
223
+ seenNames.add(entry.name);
224
+ }
225
+ catch {
226
+ // Skip invalid schemas
227
+ }
228
+ }
229
+ }
230
+ }
231
+ }
232
+ // Add package built-in schemas (if not overridden by project or user)
233
+ const packageDir = getPackageSchemasDir();
234
+ if (fs.existsSync(packageDir)) {
235
+ for (const entry of fs.readdirSync(packageDir, { withFileTypes: true })) {
236
+ if (entry.isDirectory() && !seenNames.has(entry.name)) {
237
+ const schemaPath = path.join(packageDir, entry.name, 'schema.yaml');
238
+ if (fs.existsSync(schemaPath)) {
239
+ try {
240
+ const schema = parseSchema(fs.readFileSync(schemaPath, 'utf-8'));
241
+ schemas.push({
242
+ name: entry.name,
243
+ description: schema.description || '',
244
+ artifacts: schema.artifacts.map((a) => a.id),
245
+ source: 'package',
246
+ });
247
+ }
248
+ catch {
249
+ // Skip invalid schemas
250
+ }
251
+ }
252
+ }
253
+ }
254
+ }
255
+ return schemas.sort((a, b) => a.name.localeCompare(b.name));
256
+ }
257
+ //# sourceMappingURL=resolver.js.map