forge-workflow 0.0.4 → 0.0.5

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 (209) hide show
  1. package/.claude/commands/dev.md +340 -340
  2. package/.claude/commands/plan.md +521 -521
  3. package/.claude/commands/premerge.md +176 -176
  4. package/.claude/commands/research.md +42 -42
  5. package/.claude/commands/review.md +442 -442
  6. package/.claude/commands/rollback.md +721 -721
  7. package/.claude/commands/ship.md +164 -164
  8. package/.claude/commands/sonarcloud.md +152 -152
  9. package/.claude/commands/status.md +48 -48
  10. package/.claude/commands/validate.md +282 -282
  11. package/.claude/commands/verify.md +221 -221
  12. package/.claude/rules/greptile-review-process.md +285 -285
  13. package/.claude/rules/workflow.md +105 -105
  14. package/.claude/scripts/greptile-resolve.sh +526 -526
  15. package/.claude/scripts/load-env.sh +32 -32
  16. package/.cline/workflows/dev.md +337 -337
  17. package/.cline/workflows/plan.md +518 -518
  18. package/.cline/workflows/premerge.md +173 -173
  19. package/.cline/workflows/research.md +39 -39
  20. package/.cline/workflows/review.md +439 -439
  21. package/.cline/workflows/rollback.md +718 -718
  22. package/.cline/workflows/ship.md +161 -161
  23. package/.cline/workflows/sonarcloud.md +146 -146
  24. package/.cline/workflows/status.md +45 -45
  25. package/.cline/workflows/validate.md +279 -279
  26. package/.cline/workflows/verify.md +218 -218
  27. package/.codex/config.toml +11 -11
  28. package/.codex/skills/dev/SKILL.md +340 -340
  29. package/.codex/skills/plan/SKILL.md +521 -521
  30. package/.codex/skills/premerge/SKILL.md +176 -176
  31. package/.codex/skills/research/SKILL.md +42 -42
  32. package/.codex/skills/review/SKILL.md +442 -442
  33. package/.codex/skills/rollback/SKILL.md +721 -721
  34. package/.codex/skills/ship/SKILL.md +164 -164
  35. package/.codex/skills/sonarcloud/SKILL.md +149 -149
  36. package/.codex/skills/status/SKILL.md +48 -48
  37. package/.codex/skills/validate/SKILL.md +282 -282
  38. package/.codex/skills/verify/SKILL.md +221 -221
  39. package/.cursor/commands/dev.md +337 -337
  40. package/.cursor/commands/plan.md +518 -518
  41. package/.cursor/commands/premerge.md +173 -173
  42. package/.cursor/commands/research.md +39 -39
  43. package/.cursor/commands/review.md +439 -439
  44. package/.cursor/commands/rollback.md +718 -718
  45. package/.cursor/commands/ship.md +161 -161
  46. package/.cursor/commands/sonarcloud.md +146 -146
  47. package/.cursor/commands/status.md +45 -45
  48. package/.cursor/commands/validate.md +279 -279
  49. package/.cursor/commands/verify.md +218 -218
  50. package/.cursor/rules/permissions-guidance.mdc +37 -37
  51. package/.forge/hooks/check-tdd.js +240 -240
  52. package/.github/PLUGIN_TEMPLATE.json +32 -32
  53. package/.github/prompts/dev.prompt.md +342 -342
  54. package/.github/prompts/plan.prompt.md +523 -523
  55. package/.github/prompts/premerge.prompt.md +178 -178
  56. package/.github/prompts/research.prompt.md +44 -44
  57. package/.github/prompts/review.prompt.md +444 -444
  58. package/.github/prompts/rollback.prompt.md +723 -723
  59. package/.github/prompts/ship.prompt.md +166 -166
  60. package/.github/prompts/sonarcloud.prompt.md +151 -151
  61. package/.github/prompts/status.prompt.md +50 -50
  62. package/.github/prompts/validate.prompt.md +284 -284
  63. package/.github/prompts/verify.prompt.md +223 -223
  64. package/.github/workflows/beads-to-github.yml +56 -0
  65. package/.github/workflows/github-to-beads.yml +97 -0
  66. package/.kilocode/workflows/dev.md +341 -341
  67. package/.kilocode/workflows/plan.md +522 -522
  68. package/.kilocode/workflows/premerge.md +177 -177
  69. package/.kilocode/workflows/research.md +43 -43
  70. package/.kilocode/workflows/review.md +443 -443
  71. package/.kilocode/workflows/rollback.md +722 -722
  72. package/.kilocode/workflows/ship.md +165 -165
  73. package/.kilocode/workflows/sonarcloud.md +150 -150
  74. package/.kilocode/workflows/status.md +49 -49
  75. package/.kilocode/workflows/validate.md +283 -283
  76. package/.kilocode/workflows/verify.md +222 -222
  77. package/.mcp.json.example +12 -12
  78. package/.opencode/commands/dev.md +340 -340
  79. package/.opencode/commands/plan.md +521 -521
  80. package/.opencode/commands/premerge.md +176 -176
  81. package/.opencode/commands/research.md +42 -42
  82. package/.opencode/commands/review.md +442 -442
  83. package/.opencode/commands/rollback.md +721 -721
  84. package/.opencode/commands/ship.md +164 -164
  85. package/.opencode/commands/sonarcloud.md +149 -149
  86. package/.opencode/commands/status.md +48 -48
  87. package/.opencode/commands/validate.md +282 -282
  88. package/.opencode/commands/verify.md +221 -221
  89. package/.roo/commands/dev.md +341 -341
  90. package/.roo/commands/plan.md +522 -522
  91. package/.roo/commands/premerge.md +177 -177
  92. package/.roo/commands/research.md +43 -43
  93. package/.roo/commands/review.md +443 -443
  94. package/.roo/commands/rollback.md +722 -722
  95. package/.roo/commands/ship.md +165 -165
  96. package/.roo/commands/sonarcloud.md +150 -150
  97. package/.roo/commands/status.md +49 -49
  98. package/.roo/commands/validate.md +283 -283
  99. package/.roo/commands/verify.md +222 -222
  100. package/AGENTS.md +175 -175
  101. package/CLAUDE.md +100 -100
  102. package/README.md +429 -416
  103. package/bin/forge-cmd.js +313 -313
  104. package/bin/forge-preflight.js +309 -309
  105. package/bin/forge.js +4596 -4303
  106. package/docs/AGENT_INSTALL_PROMPT.md +342 -342
  107. package/docs/BEADS_GITHUB_SYNC.md +251 -251
  108. package/docs/ENHANCED_ONBOARDING.md +602 -602
  109. package/docs/EXAMPLES.md +482 -482
  110. package/docs/GREPTILE_SETUP.md +400 -400
  111. package/docs/MANUAL_REVIEW_GUIDE.md +106 -106
  112. package/docs/ROADMAP.md +359 -359
  113. package/docs/SETUP.md +663 -631
  114. package/docs/TOOLCHAIN.md +630 -630
  115. package/docs/VALIDATION.md +363 -363
  116. package/install.sh +40 -1056
  117. package/lefthook.yml +39 -39
  118. package/lib/agents/README.md +198 -198
  119. package/lib/agents/claude.plugin.json +28 -28
  120. package/lib/agents/cline.plugin.json +22 -22
  121. package/lib/agents/codex.plugin.json +19 -19
  122. package/lib/agents/copilot.plugin.json +24 -24
  123. package/lib/agents/cursor.plugin.json +25 -25
  124. package/lib/agents/kilocode.plugin.json +22 -22
  125. package/lib/agents/opencode.plugin.json +20 -20
  126. package/lib/agents/roo.plugin.json +23 -23
  127. package/lib/agents-config.js +2112 -2112
  128. package/lib/beads-health-check.js +143 -0
  129. package/lib/beads-setup.js +341 -0
  130. package/lib/beads-sync-scaffold.js +260 -0
  131. package/lib/commands/dev.js +513 -513
  132. package/lib/commands/plan.js +692 -692
  133. package/lib/commands/recommend.js +119 -119
  134. package/lib/commands/ship.js +377 -377
  135. package/lib/commands/status.js +378 -378
  136. package/lib/commands/validate.js +602 -602
  137. package/lib/context-merge.js +359 -359
  138. package/lib/dep-guard/analyzer.js +294 -294
  139. package/lib/dep-guard/behavior-detector.js +98 -98
  140. package/lib/dep-guard/contract-detector.js +162 -162
  141. package/lib/dep-guard/import-detector.js +498 -498
  142. package/lib/dep-guard/path-utils.js +13 -13
  143. package/lib/dep-guard/rubric.js +120 -120
  144. package/lib/dep-guard/task-parser.js +318 -318
  145. package/lib/detect-agent.js +191 -191
  146. package/lib/detect-worktree.js +47 -47
  147. package/lib/file-hash.js +26 -26
  148. package/lib/husky-migration.js +450 -0
  149. package/lib/lefthook-check.js +65 -0
  150. package/lib/pat-setup.js +207 -0
  151. package/lib/plugin-catalog.js +350 -350
  152. package/lib/plugin-manager.js +166 -166
  153. package/lib/plugin-recommender.js +141 -141
  154. package/lib/project-discovery.js +491 -491
  155. package/lib/setup-action-log.js +139 -139
  156. package/lib/setup-summary-renderer.js +106 -106
  157. package/lib/setup-utils.js +96 -0
  158. package/lib/setup.js +192 -192
  159. package/lib/smart-merge.js +64 -0
  160. package/lib/symlink-utils.js +81 -0
  161. package/lib/workflow-profiles.js +197 -197
  162. package/package.json +131 -128
  163. package/scripts/beads-context.sh +291 -0
  164. package/scripts/beads-context.test.js +563 -0
  165. package/scripts/behavioral-judge.sh +378 -0
  166. package/scripts/benchmark.js +85 -0
  167. package/scripts/branch-protection.js +183 -0
  168. package/scripts/check-agents.js +172 -0
  169. package/scripts/commitlint.js +42 -0
  170. package/scripts/conflict-detect.sh +323 -0
  171. package/scripts/dep-guard-analyze.js +71 -0
  172. package/scripts/dep-guard.sh +811 -0
  173. package/scripts/eval_win.py +249 -0
  174. package/scripts/file-index.sh +399 -0
  175. package/scripts/github-beads-sync/comment.mjs +64 -0
  176. package/scripts/github-beads-sync/config.mjs +148 -0
  177. package/scripts/github-beads-sync/github-api.mjs +131 -0
  178. package/scripts/github-beads-sync/index.mjs +332 -0
  179. package/scripts/github-beads-sync/label-mapper.mjs +54 -0
  180. package/scripts/github-beads-sync/mapping.mjs +78 -0
  181. package/scripts/github-beads-sync/reverse-sync-cli.mjs +31 -0
  182. package/scripts/github-beads-sync/reverse-sync.mjs +138 -0
  183. package/scripts/github-beads-sync/run-bd.mjs +159 -0
  184. package/scripts/github-beads-sync/sanitize.mjs +121 -0
  185. package/scripts/github-beads-sync.config.json +26 -0
  186. package/scripts/improve-command.js +375 -0
  187. package/scripts/lib/eval-runner.js +229 -0
  188. package/scripts/lib/eval-schema.js +135 -0
  189. package/scripts/lib/eval-storage.js +78 -0
  190. package/scripts/lib/grading.js +203 -0
  191. package/scripts/lib/transcript-parser.js +63 -0
  192. package/scripts/lint.js +47 -0
  193. package/scripts/migrate-to-bun-test.js +412 -0
  194. package/scripts/run-command-eval.js +236 -0
  195. package/scripts/smart-status.sh +782 -0
  196. package/scripts/sync-commands.js +571 -0
  197. package/scripts/sync-utils.sh +460 -0
  198. package/scripts/test-dashboard.js +123 -0
  199. package/scripts/test.js +44 -0
  200. package/scripts/validate.sh +94 -0
  201. package/skills/parallel-deep-research/SKILL.md +108 -108
  202. package/skills/parallel-deep-research/evals/README.md +27 -27
  203. package/skills/parallel-deep-research/evals/evals.json +62 -62
  204. package/skills/sonarcloud-analysis/SKILL.md +171 -171
  205. package/skills/sonarcloud-analysis/evals/README.md +27 -27
  206. package/skills/sonarcloud-analysis/evals/evals.json +50 -50
  207. package/skills/sonarcloud-analysis/references/api-reference.md +466 -466
  208. package/.cursor/hooks/state/continual-learning-index.json +0 -19
  209. package/.cursor/hooks/state/continual-learning.json +0 -8
@@ -1,377 +1,377 @@
1
- /**
2
- * Ship Command - PR Creation with Auto-Generated Documentation
3
- * Creates pull requests with comprehensive body generated from research and metrics
4
- *
5
- * Security: Uses execFileSync for command execution to prevent injection
6
- * Automation: Extracts key decisions, test scenarios, and coverage metrics
7
- *
8
- * @module commands/ship
9
- */
10
-
11
- const { execFileSync } = require('node:child_process');
12
- const fs = require('node:fs');
13
- const path = require('node:path');
14
-
15
- function getExecOptions() {
16
- return { encoding: 'utf8', cwd: process.cwd(), timeout: 120000 };
17
- }
18
-
19
- function getGhCheckOptions() {
20
- return { encoding: 'utf8', cwd: process.cwd(), timeout: 3000 };
21
- }
22
-
23
- const VALID_PR_PREFIXES = ['feat:', 'fix:', 'docs:', 'refactor:', 'test:', 'chore:', 'perf:', 'ci:', 'build:', 'revert:'];
24
-
25
- const MAX_SLUG_LENGTH = 100;
26
- const MAX_FILE_SIZE = 5 * 1024 * 1024; // 5MB
27
-
28
- function isCommandNotFound(error) {
29
- return error.message.includes('ENOENT') || error.message.includes('not found');
30
- }
31
-
32
- /**
33
- * Validate feature slug format
34
- * Ensures slug matches expected pattern and doesn't contain path traversal
35
- * @private
36
- */
37
- function validateFeatureSlug(slug) {
38
- if (!slug || typeof slug !== 'string') {
39
- return { valid: false, error: 'Feature slug must be a non-empty string' };
40
- }
41
-
42
- // Length limits (prevent DoS)
43
- const MIN_SLUG_LENGTH = 3;
44
-
45
- if (slug.length < MIN_SLUG_LENGTH) {
46
- return { valid: false, error: `Slug too short (minimum ${MIN_SLUG_LENGTH} characters)` };
47
- }
48
-
49
- if (slug.length > MAX_SLUG_LENGTH) {
50
- return { valid: false, error: `Slug too long (maximum ${MAX_SLUG_LENGTH} characters)` };
51
- }
52
-
53
- // Only allow lowercase alphanumeric and hyphens; must start and end with alphanumeric
54
- const slugPattern = /^[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$/; // NOSONAR S5852 - no backtracking: anchored, alternation is possessive
55
- if (!slugPattern.test(slug)) {
56
- return {
57
- valid: false,
58
- error: `Invalid slug format '${slug}'. Only lowercase letters, numbers, and hyphens allowed.`,
59
- };
60
- }
61
-
62
- return { valid: true };
63
- }
64
-
65
- function extractKeyDecisions(researchContent) { // NOSONAR S3776
66
- if (!researchContent || typeof researchContent !== 'string') return [];
67
- const decisions = [];
68
-
69
- // Split by sections to avoid ReDoS - safer than complex regex
70
- const lines = researchContent.split('\n');
71
- let inDecisionsSection = false;
72
- let sectionContent = [];
73
-
74
- for (const line of lines) {
75
- if (/^##\s+Key Decisions/i.test(line)) {
76
- inDecisionsSection = true;
77
- continue;
78
- }
79
- if (inDecisionsSection && /^##\s+/.test(line)) {
80
- // Hit next section, stop
81
- break;
82
- }
83
- if (inDecisionsSection) {
84
- sectionContent.push(line);
85
- }
86
- }
87
-
88
- // Extract bullet format: "- **Decision N**: value"
89
- for (const line of sectionContent) {
90
- const boldStart = line.indexOf('**Decision');
91
- if (boldStart === -1) continue;
92
- const afterDecision = line.slice(boldStart + 10); // after '**Decision'
93
- const closingBold = afterDecision.indexOf('**:');
94
- if (closingBold === -1) continue;
95
- const value = afterDecision.slice(closingBold + 3).trim();
96
- if (value) decisions.push(value);
97
- }
98
-
99
- // Extract heading format:
100
- // "### Decision N: Title" (+ optional "**Reasoning**: ...")
101
- for (let i = 0; i < sectionContent.length; i++) {
102
- const headingMatch = /^###\s*Decision\s*\d+:\s*([^\n]+)/i.exec(sectionContent[i]); // NOSONAR S5852 - anchored with bounded capture
103
- if (!headingMatch) continue;
104
-
105
- const title = headingMatch[1].trim();
106
- if (!title) continue;
107
-
108
- let reasoning = '';
109
- for (let j = i + 1; j < sectionContent.length; j++) {
110
- const nextLine = sectionContent[j];
111
-
112
- // Stop when the next decision heading or a new top-level section starts
113
- if (/^###\s*Decision\s*\d+:/i.test(nextLine) || /^##\s+/.test(nextLine)) break;
114
-
115
- const reasoningMatch = /^\*\*Reasoning\*\*:\s*([^\n]+)/i.exec(nextLine); // NOSONAR S5852 - anchored with bounded capture
116
- if (reasoningMatch) {
117
- reasoning = reasoningMatch[1].trim();
118
- break;
119
- }
120
- }
121
-
122
- const formattedDecision = reasoning ? `${title} - Reasoning: ${reasoning}` : title;
123
- decisions.push(formattedDecision);
124
- }
125
-
126
- // Deduplicate if documents include both representations for the same decision
127
- return [...new Set(decisions)];
128
- }
129
-
130
- function extractTestScenarios(researchContent) {
131
- if (!researchContent || typeof researchContent !== 'string') return [];
132
- const scenarios = [];
133
-
134
- // Split by sections to avoid ReDoS - safer than complex regex
135
- const lines = researchContent.split('\n');
136
- let inScenariosSection = false;
137
- let sectionContent = [];
138
-
139
- for (const line of lines) {
140
- if (/^##\s+(?:TDD\s+)?Test Scenarios/i.test(line)) {
141
- inScenariosSection = true;
142
- continue;
143
- }
144
- if (inScenariosSection && /^##\s+/.test(line)) {
145
- // Hit next section, stop
146
- break;
147
- }
148
- if (inScenariosSection) {
149
- sectionContent.push(line);
150
- }
151
- }
152
-
153
- // Extract scenarios from both supported formats:
154
- // 1) "1. Scenario description"
155
- // 2) "### Scenario N: Scenario description"
156
- for (const line of sectionContent) {
157
- const numberedMatch = /^\d+\.\s+([^\n]+)$/.exec(line); // NOSONAR S5852 - anchored with bounded capture
158
- if (numberedMatch) {
159
- scenarios.push(numberedMatch[1].trim());
160
- continue;
161
- }
162
-
163
- const headingMatch = /^###\s*Scenario\s*\d+:\s*([^\n]+)$/i.exec(line); // NOSONAR S5852 - anchored with bounded capture
164
- if (headingMatch) {
165
- scenarios.push(headingMatch[1].trim());
166
- }
167
- }
168
- return scenarios;
169
- }
170
-
171
- async function getTestCoverage() {
172
- try {
173
- const coveragePath = path.join(process.cwd(), 'coverage', 'coverage-summary.json');
174
- if (!fs.existsSync(coveragePath)) {
175
- // Return object indicating no coverage instead of null
176
- return { available: false };
177
- }
178
- const coverageData = JSON.parse(fs.readFileSync(coveragePath, 'utf8'));
179
- const totals = coverageData.total;
180
- return {
181
- available: true,
182
- lines: totals.lines.pct,
183
- branches: totals.branches.pct,
184
- functions: totals.functions.pct,
185
- statements: totals.statements.pct,
186
- };
187
- } catch (error_) { // NOSONAR S2486 - intentional: file read failure returns unavailable
188
- void error_;
189
- // Return object indicating error instead of null
190
- return { available: false, error: true };
191
- }
192
- }
193
-
194
- function generatePRBody(context) {
195
- const { featureName, researchDoc, decisions = [], testScenarios = [], coverage } = context;
196
- let body = `## Summary
197
-
198
- Implements **${featureName}**
199
-
200
- `;
201
- if (researchDoc) {
202
- body += `**Research:** [${path.basename(researchDoc)}](${researchDoc})
203
-
204
- `;
205
- }
206
- if (decisions.length > 0) {
207
- body += `## Key Decisions
208
-
209
- `;
210
- decisions.forEach(decision => { body += `- ${decision}\n`; });
211
- body += '\n';
212
- }
213
- if (testScenarios.length > 0) {
214
- body += `## Test Scenarios
215
-
216
- `;
217
- testScenarios.forEach(scenario => { body += `- ${scenario}\n`; });
218
- body += '\n';
219
- }
220
- // Include coverage if available (handles both old and new format)
221
- if (coverage && (coverage.available !== false) && coverage.lines !== undefined) {
222
- body += `## Test Coverage
223
-
224
- - **Lines:** ${coverage.lines}%
225
- - **Branches:** ${coverage.branches}%
226
- - **Functions:** ${coverage.functions}%
227
- - **Statements:** ${coverage.statements}%
228
-
229
- `;
230
- }
231
- body += `## Development Approach
232
-
233
- ✅ **TDD (Test-Driven Development)**
234
- - Tests written before implementation
235
- - RED-GREEN-REFACTOR cycles
236
- - All tests passing
237
-
238
- ---
239
-
240
- 🤖 Generated with [Forge Workflow](https://github.com/anthropics/forge)
241
- `;
242
- return body;
243
- }
244
-
245
- function validatePRTitle(title) {
246
- if (!title || typeof title !== 'string') {
247
- return { valid: false, error: 'PR title is required' };
248
- }
249
- const hasValidPrefix = VALID_PR_PREFIXES.some(prefix => title.startsWith(prefix));
250
- if (!hasValidPrefix) {
251
- return { valid: false, error: `PR title must start with a valid prefix: ${VALID_PR_PREFIXES.join(', ')}` };
252
- }
253
- if (title.length < 10) return { valid: false, error: 'PR title too short (minimum 10 characters)' };
254
- if (title.length > 100) return { valid: false, error: 'PR title too long (maximum 100 characters)' };
255
- return { valid: true };
256
- }
257
-
258
- async function createPR(options) { // NOSONAR S3776
259
- const { title, body, dryRun = false } = options;
260
- const titleValidation = validatePRTitle(title);
261
- if (!titleValidation.valid) return { success: false, error: titleValidation.error };
262
- try {
263
- execFileSync('gh', ['--version'], getGhCheckOptions()); // NOSONAR S4036 - hardcoded CLI command, no user input, developer tool context
264
- } catch (error) {
265
- if (isCommandNotFound(error)) {
266
- return { success: false, error: 'GitHub CLI (gh) not found. Install from: https://cli.github.com/' };
267
- }
268
- if (error.killed && error.signal === 'SIGTERM') {
269
- return { success: false, error: 'GitHub CLI version check timed out. Check gh installation.' };
270
- }
271
- // Catch-all: other errors (permissions, corrupted binary, etc.)
272
- return { success: false, error: `GitHub CLI check failed: ${error.message}` };
273
- }
274
- try {
275
- execFileSync('git', ['rev-parse', '--git-dir'], getExecOptions()); // NOSONAR S4036 - hardcoded CLI command, no user input, developer tool context
276
- } catch (error_) { // NOSONAR S2486 - intentional: not-a-git-repo is the expected failure signal
277
- void error_;
278
- return { success: false, error: 'Not in a git repository. Initialize with: git init' };
279
- }
280
- try {
281
- execFileSync('git', ['remote', 'get-url', 'origin'], getExecOptions()); // NOSONAR S4036 - hardcoded CLI command, no user input, developer tool context
282
- } catch (error_) { // NOSONAR S2486 - intentional: no-remote is the expected failure signal
283
- void error_;
284
- return { success: false, error: 'No git remote configured. Add with: git remote add origin <url>' };
285
- }
286
- if (dryRun) {
287
- return { success: true, message: '[DRY RUN] Would create PR with title: ' + title, prUrl: 'https://github.com/owner/repo/pull/1' };
288
- }
289
- try {
290
- const result = execFileSync('gh', ['pr', 'create', '--title', title, '--body', body], getExecOptions()); // NOSONAR S4036 - hardcoded CLI command, no user input, developer tool context
291
- const urlMatch = /https:\/\/github\.com\/[^\s]+/.exec(result);
292
- const prUrl = urlMatch ? urlMatch[0] : null;
293
- const numberMatch = /\/pull\/(\d+)/.exec(result);
294
- const prNumber = numberMatch ? Number.parseInt(numberMatch[1], 10) : null;
295
- return { success: true, prUrl, prNumber, output: result };
296
- } catch (error) {
297
- // Check for timeout
298
- if (error.killed && error.signal === 'SIGTERM') {
299
- return { success: false, error: 'GitHub CLI command timed out after 2 minutes. Check network connection.' };
300
- }
301
- return { success: false, error: `Failed to create PR: ${error.message}`, output: error.stdout || error.message };
302
- }
303
- }
304
-
305
- async function executeShip(options) {
306
- const { featureSlug, title, dryRun = false } = options || {};
307
-
308
- // Validate feature slug
309
- if (!featureSlug || typeof featureSlug !== 'string' || featureSlug.trim() === '') {
310
- return { success: false, error: 'Feature slug is required and must be a non-empty string' };
311
- }
312
-
313
- const slugValidation = validateFeatureSlug(featureSlug);
314
- if (!slugValidation.valid) {
315
- return { success: false, error: slugValidation.error };
316
- }
317
-
318
- // Validate PR title
319
- if (!title || typeof title !== 'string' || title.trim() === '') {
320
- return { success: false, error: 'PR title is required and must be a non-empty string' };
321
- }
322
-
323
- const titleValidation = validatePRTitle(title);
324
- if (!titleValidation.valid) {
325
- return { success: false, error: titleValidation.error };
326
- }
327
-
328
- try {
329
- const researchPath = path.join(process.cwd(), 'docs', 'research', `${featureSlug}.md`);
330
- let researchContent = null;
331
- let decisions = [];
332
- let testScenarios = [];
333
- if (fs.existsSync(researchPath)) {
334
- // Check file size to prevent resource exhaustion (max 5MB)
335
- const stats = fs.statSync(researchPath);
336
- if (stats.size > MAX_FILE_SIZE) {
337
- return {
338
- success: false,
339
- error: `Research document too large (${Math.round(stats.size / 1024 / 1024)}MB). Maximum size: 5MB`,
340
- };
341
- }
342
-
343
- researchContent = fs.readFileSync(researchPath, 'utf8');
344
- decisions = extractKeyDecisions(researchContent);
345
- testScenarios = extractTestScenarios(researchContent);
346
- }
347
- const coverage = await getTestCoverage();
348
- const featureName = featureSlug.split('-').map(word => word.charAt(0).toUpperCase() + word.slice(1)).join(' ');
349
- const prBody = generatePRBody({
350
- featureName,
351
- researchDoc: researchContent ? `docs/research/${featureSlug}.md` : null,
352
- decisions,
353
- testScenarios,
354
- coverage,
355
- });
356
- const result = await createPR({ title, body: prBody, dryRun });
357
- if (!result.success) return result;
358
- return {
359
- success: true,
360
- prUrl: result.prUrl,
361
- prNumber: result.prNumber,
362
- message: dryRun ? 'Dry run successful - PR body generated' : `Pull request created successfully: ${result.prUrl}`,
363
- };
364
- } catch (error) {
365
- return { success: false, error: `Failed to execute ship command: ${error.message}` };
366
- }
367
- }
368
-
369
- module.exports = {
370
- extractKeyDecisions,
371
- extractTestScenarios,
372
- getTestCoverage,
373
- generatePRBody,
374
- validatePRTitle,
375
- createPR,
376
- executeShip,
377
- };
1
+ /**
2
+ * Ship Command - PR Creation with Auto-Generated Documentation
3
+ * Creates pull requests with comprehensive body generated from research and metrics
4
+ *
5
+ * Security: Uses execFileSync for command execution to prevent injection
6
+ * Automation: Extracts key decisions, test scenarios, and coverage metrics
7
+ *
8
+ * @module commands/ship
9
+ */
10
+
11
+ const { execFileSync } = require('node:child_process');
12
+ const fs = require('node:fs');
13
+ const path = require('node:path');
14
+
15
+ function getExecOptions() {
16
+ return { encoding: 'utf8', cwd: process.cwd(), timeout: 120000 };
17
+ }
18
+
19
+ function getGhCheckOptions() {
20
+ return { encoding: 'utf8', cwd: process.cwd(), timeout: 3000 };
21
+ }
22
+
23
+ const VALID_PR_PREFIXES = ['feat:', 'fix:', 'docs:', 'refactor:', 'test:', 'chore:', 'perf:', 'ci:', 'build:', 'revert:'];
24
+
25
+ const MAX_SLUG_LENGTH = 100;
26
+ const MAX_FILE_SIZE = 5 * 1024 * 1024; // 5MB
27
+
28
+ function isCommandNotFound(error) {
29
+ return error.message.includes('ENOENT') || error.message.includes('not found');
30
+ }
31
+
32
+ /**
33
+ * Validate feature slug format
34
+ * Ensures slug matches expected pattern and doesn't contain path traversal
35
+ * @private
36
+ */
37
+ function validateFeatureSlug(slug) {
38
+ if (!slug || typeof slug !== 'string') {
39
+ return { valid: false, error: 'Feature slug must be a non-empty string' };
40
+ }
41
+
42
+ // Length limits (prevent DoS)
43
+ const MIN_SLUG_LENGTH = 3;
44
+
45
+ if (slug.length < MIN_SLUG_LENGTH) {
46
+ return { valid: false, error: `Slug too short (minimum ${MIN_SLUG_LENGTH} characters)` };
47
+ }
48
+
49
+ if (slug.length > MAX_SLUG_LENGTH) {
50
+ return { valid: false, error: `Slug too long (maximum ${MAX_SLUG_LENGTH} characters)` };
51
+ }
52
+
53
+ // Only allow lowercase alphanumeric and hyphens; must start and end with alphanumeric
54
+ const slugPattern = /^[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$/; // NOSONAR S5852 - no backtracking: anchored, alternation is possessive
55
+ if (!slugPattern.test(slug)) {
56
+ return {
57
+ valid: false,
58
+ error: `Invalid slug format '${slug}'. Only lowercase letters, numbers, and hyphens allowed.`,
59
+ };
60
+ }
61
+
62
+ return { valid: true };
63
+ }
64
+
65
+ function extractKeyDecisions(researchContent) { // NOSONAR S3776
66
+ if (!researchContent || typeof researchContent !== 'string') return [];
67
+ const decisions = [];
68
+
69
+ // Split by sections to avoid ReDoS - safer than complex regex
70
+ const lines = researchContent.split('\n');
71
+ let inDecisionsSection = false;
72
+ let sectionContent = [];
73
+
74
+ for (const line of lines) {
75
+ if (/^##\s+Key Decisions/i.test(line)) {
76
+ inDecisionsSection = true;
77
+ continue;
78
+ }
79
+ if (inDecisionsSection && /^##\s+/.test(line)) {
80
+ // Hit next section, stop
81
+ break;
82
+ }
83
+ if (inDecisionsSection) {
84
+ sectionContent.push(line);
85
+ }
86
+ }
87
+
88
+ // Extract bullet format: "- **Decision N**: value"
89
+ for (const line of sectionContent) {
90
+ const boldStart = line.indexOf('**Decision');
91
+ if (boldStart === -1) continue;
92
+ const afterDecision = line.slice(boldStart + 10); // after '**Decision'
93
+ const closingBold = afterDecision.indexOf('**:');
94
+ if (closingBold === -1) continue;
95
+ const value = afterDecision.slice(closingBold + 3).trim();
96
+ if (value) decisions.push(value);
97
+ }
98
+
99
+ // Extract heading format:
100
+ // "### Decision N: Title" (+ optional "**Reasoning**: ...")
101
+ for (let i = 0; i < sectionContent.length; i++) {
102
+ const headingMatch = /^###\s*Decision\s*\d+:\s*([^\n]+)/i.exec(sectionContent[i]); // NOSONAR S5852 - anchored with bounded capture
103
+ if (!headingMatch) continue;
104
+
105
+ const title = headingMatch[1].trim();
106
+ if (!title) continue;
107
+
108
+ let reasoning = '';
109
+ for (let j = i + 1; j < sectionContent.length; j++) {
110
+ const nextLine = sectionContent[j];
111
+
112
+ // Stop when the next decision heading or a new top-level section starts
113
+ if (/^###\s*Decision\s*\d+:/i.test(nextLine) || /^##\s+/.test(nextLine)) break;
114
+
115
+ const reasoningMatch = /^\*\*Reasoning\*\*:\s*([^\n]+)/i.exec(nextLine); // NOSONAR S5852 - anchored with bounded capture
116
+ if (reasoningMatch) {
117
+ reasoning = reasoningMatch[1].trim();
118
+ break;
119
+ }
120
+ }
121
+
122
+ const formattedDecision = reasoning ? `${title} - Reasoning: ${reasoning}` : title;
123
+ decisions.push(formattedDecision);
124
+ }
125
+
126
+ // Deduplicate if documents include both representations for the same decision
127
+ return [...new Set(decisions)];
128
+ }
129
+
130
+ function extractTestScenarios(researchContent) {
131
+ if (!researchContent || typeof researchContent !== 'string') return [];
132
+ const scenarios = [];
133
+
134
+ // Split by sections to avoid ReDoS - safer than complex regex
135
+ const lines = researchContent.split('\n');
136
+ let inScenariosSection = false;
137
+ let sectionContent = [];
138
+
139
+ for (const line of lines) {
140
+ if (/^##\s+(?:TDD\s+)?Test Scenarios/i.test(line)) {
141
+ inScenariosSection = true;
142
+ continue;
143
+ }
144
+ if (inScenariosSection && /^##\s+/.test(line)) {
145
+ // Hit next section, stop
146
+ break;
147
+ }
148
+ if (inScenariosSection) {
149
+ sectionContent.push(line);
150
+ }
151
+ }
152
+
153
+ // Extract scenarios from both supported formats:
154
+ // 1) "1. Scenario description"
155
+ // 2) "### Scenario N: Scenario description"
156
+ for (const line of sectionContent) {
157
+ const numberedMatch = /^\d+\.\s+([^\n]+)$/.exec(line); // NOSONAR S5852 - anchored with bounded capture
158
+ if (numberedMatch) {
159
+ scenarios.push(numberedMatch[1].trim());
160
+ continue;
161
+ }
162
+
163
+ const headingMatch = /^###\s*Scenario\s*\d+:\s*([^\n]+)$/i.exec(line); // NOSONAR S5852 - anchored with bounded capture
164
+ if (headingMatch) {
165
+ scenarios.push(headingMatch[1].trim());
166
+ }
167
+ }
168
+ return scenarios;
169
+ }
170
+
171
+ async function getTestCoverage() {
172
+ try {
173
+ const coveragePath = path.join(process.cwd(), 'coverage', 'coverage-summary.json');
174
+ if (!fs.existsSync(coveragePath)) {
175
+ // Return object indicating no coverage instead of null
176
+ return { available: false };
177
+ }
178
+ const coverageData = JSON.parse(fs.readFileSync(coveragePath, 'utf8'));
179
+ const totals = coverageData.total;
180
+ return {
181
+ available: true,
182
+ lines: totals.lines.pct,
183
+ branches: totals.branches.pct,
184
+ functions: totals.functions.pct,
185
+ statements: totals.statements.pct,
186
+ };
187
+ } catch (error_) { // NOSONAR S2486 - intentional: file read failure returns unavailable
188
+ void error_;
189
+ // Return object indicating error instead of null
190
+ return { available: false, error: true };
191
+ }
192
+ }
193
+
194
+ function generatePRBody(context) {
195
+ const { featureName, researchDoc, decisions = [], testScenarios = [], coverage } = context;
196
+ let body = `## Summary
197
+
198
+ Implements **${featureName}**
199
+
200
+ `;
201
+ if (researchDoc) {
202
+ body += `**Research:** [${path.basename(researchDoc)}](${researchDoc})
203
+
204
+ `;
205
+ }
206
+ if (decisions.length > 0) {
207
+ body += `## Key Decisions
208
+
209
+ `;
210
+ decisions.forEach(decision => { body += `- ${decision}\n`; });
211
+ body += '\n';
212
+ }
213
+ if (testScenarios.length > 0) {
214
+ body += `## Test Scenarios
215
+
216
+ `;
217
+ testScenarios.forEach(scenario => { body += `- ${scenario}\n`; });
218
+ body += '\n';
219
+ }
220
+ // Include coverage if available (handles both old and new format)
221
+ if (coverage && (coverage.available !== false) && coverage.lines !== undefined) {
222
+ body += `## Test Coverage
223
+
224
+ - **Lines:** ${coverage.lines}%
225
+ - **Branches:** ${coverage.branches}%
226
+ - **Functions:** ${coverage.functions}%
227
+ - **Statements:** ${coverage.statements}%
228
+
229
+ `;
230
+ }
231
+ body += `## Development Approach
232
+
233
+ ✅ **TDD (Test-Driven Development)**
234
+ - Tests written before implementation
235
+ - RED-GREEN-REFACTOR cycles
236
+ - All tests passing
237
+
238
+ ---
239
+
240
+ 🤖 Generated with [Forge Workflow](https://github.com/anthropics/forge)
241
+ `;
242
+ return body;
243
+ }
244
+
245
+ function validatePRTitle(title) {
246
+ if (!title || typeof title !== 'string') {
247
+ return { valid: false, error: 'PR title is required' };
248
+ }
249
+ const hasValidPrefix = VALID_PR_PREFIXES.some(prefix => title.startsWith(prefix));
250
+ if (!hasValidPrefix) {
251
+ return { valid: false, error: `PR title must start with a valid prefix: ${VALID_PR_PREFIXES.join(', ')}` };
252
+ }
253
+ if (title.length < 10) return { valid: false, error: 'PR title too short (minimum 10 characters)' };
254
+ if (title.length > 100) return { valid: false, error: 'PR title too long (maximum 100 characters)' };
255
+ return { valid: true };
256
+ }
257
+
258
+ async function createPR(options) { // NOSONAR S3776
259
+ const { title, body, dryRun = false } = options;
260
+ const titleValidation = validatePRTitle(title);
261
+ if (!titleValidation.valid) return { success: false, error: titleValidation.error };
262
+ try {
263
+ execFileSync('gh', ['--version'], getGhCheckOptions()); // NOSONAR S4036 - hardcoded CLI command, no user input, developer tool context
264
+ } catch (error) {
265
+ if (isCommandNotFound(error)) {
266
+ return { success: false, error: 'GitHub CLI (gh) not found. Install from: https://cli.github.com/' };
267
+ }
268
+ if (error.killed && error.signal === 'SIGTERM') {
269
+ return { success: false, error: 'GitHub CLI version check timed out. Check gh installation.' };
270
+ }
271
+ // Catch-all: other errors (permissions, corrupted binary, etc.)
272
+ return { success: false, error: `GitHub CLI check failed: ${error.message}` };
273
+ }
274
+ try {
275
+ execFileSync('git', ['rev-parse', '--git-dir'], getExecOptions()); // NOSONAR S4036 - hardcoded CLI command, no user input, developer tool context
276
+ } catch (error_) { // NOSONAR S2486 - intentional: not-a-git-repo is the expected failure signal
277
+ void error_;
278
+ return { success: false, error: 'Not in a git repository. Initialize with: git init' };
279
+ }
280
+ try {
281
+ execFileSync('git', ['remote', 'get-url', 'origin'], getExecOptions()); // NOSONAR S4036 - hardcoded CLI command, no user input, developer tool context
282
+ } catch (error_) { // NOSONAR S2486 - intentional: no-remote is the expected failure signal
283
+ void error_;
284
+ return { success: false, error: 'No git remote configured. Add with: git remote add origin <url>' };
285
+ }
286
+ if (dryRun) {
287
+ return { success: true, message: '[DRY RUN] Would create PR with title: ' + title, prUrl: 'https://github.com/owner/repo/pull/1' };
288
+ }
289
+ try {
290
+ const result = execFileSync('gh', ['pr', 'create', '--title', title, '--body', body], getExecOptions()); // NOSONAR S4036 - hardcoded CLI command, no user input, developer tool context
291
+ const urlMatch = /https:\/\/github\.com\/[^\s]+/.exec(result);
292
+ const prUrl = urlMatch ? urlMatch[0] : null;
293
+ const numberMatch = /\/pull\/(\d+)/.exec(result);
294
+ const prNumber = numberMatch ? Number.parseInt(numberMatch[1], 10) : null;
295
+ return { success: true, prUrl, prNumber, output: result };
296
+ } catch (error) {
297
+ // Check for timeout
298
+ if (error.killed && error.signal === 'SIGTERM') {
299
+ return { success: false, error: 'GitHub CLI command timed out after 2 minutes. Check network connection.' };
300
+ }
301
+ return { success: false, error: `Failed to create PR: ${error.message}`, output: error.stdout || error.message };
302
+ }
303
+ }
304
+
305
+ async function executeShip(options) {
306
+ const { featureSlug, title, dryRun = false } = options || {};
307
+
308
+ // Validate feature slug
309
+ if (!featureSlug || typeof featureSlug !== 'string' || featureSlug.trim() === '') {
310
+ return { success: false, error: 'Feature slug is required and must be a non-empty string' };
311
+ }
312
+
313
+ const slugValidation = validateFeatureSlug(featureSlug);
314
+ if (!slugValidation.valid) {
315
+ return { success: false, error: slugValidation.error };
316
+ }
317
+
318
+ // Validate PR title
319
+ if (!title || typeof title !== 'string' || title.trim() === '') {
320
+ return { success: false, error: 'PR title is required and must be a non-empty string' };
321
+ }
322
+
323
+ const titleValidation = validatePRTitle(title);
324
+ if (!titleValidation.valid) {
325
+ return { success: false, error: titleValidation.error };
326
+ }
327
+
328
+ try {
329
+ const researchPath = path.join(process.cwd(), 'docs', 'research', `${featureSlug}.md`);
330
+ let researchContent = null;
331
+ let decisions = [];
332
+ let testScenarios = [];
333
+ if (fs.existsSync(researchPath)) {
334
+ // Check file size to prevent resource exhaustion (max 5MB)
335
+ const stats = fs.statSync(researchPath);
336
+ if (stats.size > MAX_FILE_SIZE) {
337
+ return {
338
+ success: false,
339
+ error: `Research document too large (${Math.round(stats.size / 1024 / 1024)}MB). Maximum size: 5MB`,
340
+ };
341
+ }
342
+
343
+ researchContent = fs.readFileSync(researchPath, 'utf8');
344
+ decisions = extractKeyDecisions(researchContent);
345
+ testScenarios = extractTestScenarios(researchContent);
346
+ }
347
+ const coverage = await getTestCoverage();
348
+ const featureName = featureSlug.split('-').map(word => word.charAt(0).toUpperCase() + word.slice(1)).join(' ');
349
+ const prBody = generatePRBody({
350
+ featureName,
351
+ researchDoc: researchContent ? `docs/research/${featureSlug}.md` : null,
352
+ decisions,
353
+ testScenarios,
354
+ coverage,
355
+ });
356
+ const result = await createPR({ title, body: prBody, dryRun });
357
+ if (!result.success) return result;
358
+ return {
359
+ success: true,
360
+ prUrl: result.prUrl,
361
+ prNumber: result.prNumber,
362
+ message: dryRun ? 'Dry run successful - PR body generated' : `Pull request created successfully: ${result.prUrl}`,
363
+ };
364
+ } catch (error) {
365
+ return { success: false, error: `Failed to execute ship command: ${error.message}` };
366
+ }
367
+ }
368
+
369
+ module.exports = {
370
+ extractKeyDecisions,
371
+ extractTestScenarios,
372
+ getTestCoverage,
373
+ generatePRBody,
374
+ validatePRTitle,
375
+ createPR,
376
+ executeShip,
377
+ };