forge-workflow 0.0.3 → 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 -314
  2. package/.claude/commands/plan.md +521 -478
  3. package/.claude/commands/premerge.md +176 -179
  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 -134
  8. package/.claude/commands/sonarcloud.md +152 -152
  9. package/.claude/commands/status.md +48 -77
  10. package/.claude/commands/validate.md +282 -237
  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 -311
  17. package/.cline/workflows/plan.md +518 -475
  18. package/.cline/workflows/premerge.md +173 -176
  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 -131
  23. package/.cline/workflows/sonarcloud.md +146 -146
  24. package/.cline/workflows/status.md +45 -74
  25. package/.cline/workflows/validate.md +279 -234
  26. package/.cline/workflows/verify.md +218 -218
  27. package/.codex/config.toml +11 -11
  28. package/.codex/skills/dev/SKILL.md +340 -314
  29. package/.codex/skills/plan/SKILL.md +521 -478
  30. package/.codex/skills/premerge/SKILL.md +176 -179
  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 -134
  35. package/.codex/skills/sonarcloud/SKILL.md +149 -149
  36. package/.codex/skills/status/SKILL.md +48 -77
  37. package/.codex/skills/validate/SKILL.md +282 -237
  38. package/.codex/skills/verify/SKILL.md +221 -221
  39. package/.cursor/commands/dev.md +337 -311
  40. package/.cursor/commands/plan.md +518 -475
  41. package/.cursor/commands/premerge.md +173 -176
  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 -131
  46. package/.cursor/commands/sonarcloud.md +146 -146
  47. package/.cursor/commands/status.md +45 -74
  48. package/.cursor/commands/validate.md +279 -234
  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 -316
  54. package/.github/prompts/plan.prompt.md +523 -480
  55. package/.github/prompts/premerge.prompt.md +178 -181
  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 -136
  60. package/.github/prompts/sonarcloud.prompt.md +151 -151
  61. package/.github/prompts/status.prompt.md +50 -79
  62. package/.github/prompts/validate.prompt.md +284 -239
  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 -315
  67. package/.kilocode/workflows/plan.md +522 -479
  68. package/.kilocode/workflows/premerge.md +177 -180
  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 -135
  73. package/.kilocode/workflows/sonarcloud.md +150 -150
  74. package/.kilocode/workflows/status.md +49 -78
  75. package/.kilocode/workflows/validate.md +283 -238
  76. package/.kilocode/workflows/verify.md +222 -222
  77. package/.mcp.json.example +12 -12
  78. package/.opencode/commands/dev.md +340 -314
  79. package/.opencode/commands/plan.md +521 -478
  80. package/.opencode/commands/premerge.md +176 -179
  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 -134
  85. package/.opencode/commands/sonarcloud.md +149 -149
  86. package/.opencode/commands/status.md +48 -77
  87. package/.opencode/commands/validate.md +282 -237
  88. package/.opencode/commands/verify.md +221 -221
  89. package/.roo/commands/dev.md +341 -315
  90. package/.roo/commands/plan.md +522 -479
  91. package/.roo/commands/premerge.md +177 -180
  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 -135
  96. package/.roo/commands/sonarcloud.md +150 -150
  97. package/.roo/commands/status.md +49 -78
  98. package/.roo/commands/validate.md +283 -238
  99. package/.roo/commands/verify.md +222 -222
  100. package/AGENTS.md +175 -169
  101. package/CLAUDE.md +100 -99
  102. package/LICENSE +21 -21
  103. package/README.md +429 -414
  104. package/bin/forge-cmd.js +313 -313
  105. package/bin/{forge-validate.js → forge-preflight.js} +309 -303
  106. package/bin/forge.js +4596 -4232
  107. package/docs/AGENT_INSTALL_PROMPT.md +342 -342
  108. package/docs/BEADS_GITHUB_SYNC.md +251 -0
  109. package/docs/ENHANCED_ONBOARDING.md +602 -602
  110. package/docs/EXAMPLES.md +482 -482
  111. package/docs/GREPTILE_SETUP.md +400 -400
  112. package/docs/MANUAL_REVIEW_GUIDE.md +106 -106
  113. package/docs/ROADMAP.md +359 -359
  114. package/docs/SETUP.md +663 -632
  115. package/docs/TOOLCHAIN.md +630 -630
  116. package/docs/VALIDATION.md +363 -363
  117. package/install.sh +40 -1058
  118. package/lefthook.yml +39 -39
  119. package/lib/agents/README.md +198 -198
  120. package/lib/agents/claude.plugin.json +28 -28
  121. package/lib/agents/cline.plugin.json +22 -22
  122. package/lib/agents/codex.plugin.json +19 -19
  123. package/lib/agents/copilot.plugin.json +24 -24
  124. package/lib/agents/cursor.plugin.json +25 -25
  125. package/lib/agents/kilocode.plugin.json +22 -22
  126. package/lib/agents/opencode.plugin.json +20 -20
  127. package/lib/agents/roo.plugin.json +23 -23
  128. package/lib/agents-config.js +2112 -2112
  129. package/lib/beads-health-check.js +143 -0
  130. package/lib/beads-setup.js +341 -0
  131. package/lib/beads-sync-scaffold.js +260 -0
  132. package/lib/commands/dev.js +513 -513
  133. package/lib/commands/plan.js +692 -692
  134. package/lib/commands/recommend.js +119 -119
  135. package/lib/commands/ship.js +377 -377
  136. package/lib/commands/status.js +378 -378
  137. package/lib/commands/validate.js +602 -602
  138. package/lib/context-merge.js +359 -359
  139. package/lib/dep-guard/analyzer.js +294 -294
  140. package/lib/dep-guard/behavior-detector.js +98 -98
  141. package/lib/dep-guard/contract-detector.js +162 -162
  142. package/lib/dep-guard/import-detector.js +498 -498
  143. package/lib/dep-guard/path-utils.js +13 -13
  144. package/lib/dep-guard/rubric.js +120 -120
  145. package/lib/dep-guard/task-parser.js +318 -318
  146. package/lib/detect-agent.js +191 -0
  147. package/lib/detect-worktree.js +47 -0
  148. package/lib/file-hash.js +26 -0
  149. package/lib/husky-migration.js +450 -0
  150. package/lib/lefthook-check.js +65 -0
  151. package/lib/pat-setup.js +207 -0
  152. package/lib/plugin-catalog.js +350 -350
  153. package/lib/plugin-manager.js +166 -166
  154. package/lib/plugin-recommender.js +141 -141
  155. package/lib/project-discovery.js +491 -491
  156. package/lib/setup-action-log.js +139 -0
  157. package/lib/setup-summary-renderer.js +106 -0
  158. package/lib/setup-utils.js +96 -0
  159. package/lib/setup.js +192 -118
  160. package/lib/smart-merge.js +64 -0
  161. package/lib/symlink-utils.js +81 -0
  162. package/lib/workflow-profiles.js +197 -197
  163. package/package.json +131 -129
  164. package/scripts/beads-context.sh +291 -0
  165. package/scripts/beads-context.test.js +563 -0
  166. package/scripts/behavioral-judge.sh +378 -0
  167. package/scripts/benchmark.js +85 -0
  168. package/scripts/branch-protection.js +183 -0
  169. package/scripts/check-agents.js +172 -0
  170. package/scripts/commitlint.js +42 -0
  171. package/scripts/conflict-detect.sh +323 -0
  172. package/scripts/dep-guard-analyze.js +71 -0
  173. package/scripts/dep-guard.sh +811 -0
  174. package/scripts/eval_win.py +249 -0
  175. package/scripts/file-index.sh +399 -0
  176. package/scripts/github-beads-sync/comment.mjs +64 -0
  177. package/scripts/github-beads-sync/config.mjs +148 -0
  178. package/scripts/github-beads-sync/github-api.mjs +131 -0
  179. package/scripts/github-beads-sync/index.mjs +332 -0
  180. package/scripts/github-beads-sync/label-mapper.mjs +54 -0
  181. package/scripts/github-beads-sync/mapping.mjs +78 -0
  182. package/scripts/github-beads-sync/reverse-sync-cli.mjs +31 -0
  183. package/scripts/github-beads-sync/reverse-sync.mjs +138 -0
  184. package/scripts/github-beads-sync/run-bd.mjs +159 -0
  185. package/scripts/github-beads-sync/sanitize.mjs +121 -0
  186. package/scripts/github-beads-sync.config.json +26 -0
  187. package/scripts/improve-command.js +375 -0
  188. package/scripts/lib/eval-runner.js +229 -0
  189. package/scripts/lib/eval-schema.js +135 -0
  190. package/scripts/lib/eval-storage.js +78 -0
  191. package/scripts/lib/grading.js +203 -0
  192. package/scripts/lib/transcript-parser.js +63 -0
  193. package/scripts/lint.js +47 -0
  194. package/scripts/migrate-to-bun-test.js +412 -0
  195. package/scripts/run-command-eval.js +236 -0
  196. package/scripts/smart-status.sh +782 -0
  197. package/scripts/sync-commands.js +571 -0
  198. package/scripts/sync-utils.sh +460 -0
  199. package/scripts/test-dashboard.js +123 -0
  200. package/scripts/test.js +44 -0
  201. package/scripts/validate.sh +94 -0
  202. package/skills/parallel-deep-research/SKILL.md +108 -108
  203. package/skills/parallel-deep-research/evals/README.md +27 -27
  204. package/skills/parallel-deep-research/evals/evals.json +62 -62
  205. package/skills/sonarcloud-analysis/SKILL.md +171 -171
  206. package/skills/sonarcloud-analysis/evals/README.md +27 -27
  207. package/skills/sonarcloud-analysis/evals/evals.json +50 -50
  208. package/skills/sonarcloud-analysis/references/api-reference.md +466 -466
  209. package/docs/WORKFLOW.md +0 -400
@@ -1,135 +1,165 @@
1
- ---
2
- description: Create PR with comprehensive documentation
3
- mode: code
4
- ---
5
-
6
- Push code and create a pull request with full context and documentation links.
7
-
8
- # Ship
9
-
10
- This command creates a PR after validation passes.
11
-
12
- ## Usage
13
-
14
- ```bash
15
- /ship
16
- ```
17
-
18
- ```
19
- <HARD-GATE: /ship entry>
20
- Do NOT create PR until:
21
- 1. /validate was run in this session with all four outputs shown (type, lint, tests, security)
22
- 2. All checks confirmed passing — not assumed, not "was passing earlier"
23
- 3. Beads issue is in_progress
24
- 4. git branch --show-current output is NOT main or master
25
- </HARD-GATE>
26
- ```
27
-
28
- ## What This Command Does
29
-
30
- ### Step 1: Verify /validate Passed
31
- Ensure all four validation checks completed successfully with fresh output in this session.
32
-
33
- ### Step 2: Update Beads
34
- ```bash
35
- bd update <id> --status done
36
- bd sync
37
- ```
38
-
39
- ### Step 3: Push Branch
40
- ```bash
41
- git push -u origin <branch-name>
42
- ```
43
-
44
- ### Step 4: Create PR
45
-
46
- ```bash
47
- gh pr create --title "feat: <feature-name>" --body "$(cat <<'EOF'
48
- ## Summary
49
- [Auto-generated from commits and design doc]
50
-
51
- ## Design Doc
52
- See: docs/plans/YYYY-MM-DD-<slug>-design.md
53
-
54
- ## Decisions Log
55
- See: docs/plans/YYYY-MM-DD-<slug>-decisions.md (if any undocumented decisions arose during /dev)
56
-
57
- ## Beads Issue
58
- Closes: <issue-id>
59
-
60
- ## Key Decisions
61
- [From design doc - 3-5 key decisions with reasoning]
62
-
63
- ## TDD Test Coverage
64
- - Unit tests: [count] tests, [X] scenarios
65
- - Integration tests: [count] tests
66
- - E2E tests: [count] tests
67
- - All tests passing ✓
68
-
69
- ## Security Review
70
- - OWASP Top 10: All mitigations implemented
71
- - Security tests: [count] scenarios passing
72
- - Automated scan: No vulnerabilities
73
-
74
- ## Test Plan
75
- - [x] Type check passing
76
- - [x] Lint passing
77
- - [x] Code review passing
78
- - [x] E2E tests passing
79
- - [x] Security review completed
80
-
81
- 🤖 Generated with [Claude Code](https://claude.com/claude-code)
82
- EOF
83
- )"
84
- ```
85
-
86
- ### Step 5: Record Stage Transition
87
- ```bash
88
- bash scripts/beads-context.sh stage-transition <id> ship review
89
- ```
90
-
91
- ## Example Output
92
-
93
- ```
94
- Validation: /validate passed (all 4 checks — fresh output confirmed)
95
- Beads: Marked done & synced (forge-xyz)
96
- Pushed: feat/stripe-billing
97
- ✓ PR created: https://github.com/.../pull/123
98
- - Beads linked: forge-xyz
99
- - Design doc linked: docs/plans/2026-02-26-stripe-billing-design.md
100
- - Decisions log linked: docs/plans/2026-02-26-stripe-billing-decisions.md
101
- - Test coverage documented
102
- - Security review documented
103
-
104
- PR Summary:
105
- - 12 commits
106
- - 18 test cases, all passing
107
- - OWASP Top 10 security review completed
108
- - 3 key architectural decisions documented
109
-
110
- ⏸️ PR created, awaiting automated checks (Greptile, SonarCloud, GitHub Actions)
111
-
112
- Next: /review <pr-number> (after automated checks complete)
113
- ```
114
-
115
- ## Integration with Workflow
116
-
117
- ```
118
- Utility: /status → Understand current context before starting
119
- Stage 1: /plan → Design intent → research → branch + worktree + task list
120
- Stage 2: /dev → Implement each task with subagent-driven TDD
121
- Stage 3: /validate → Type check, lint, tests, security — all fresh output
122
- Stage 4: /ship → Push + create PR (you are here)
123
- Stage 5: /review → Address GitHub Actions, Greptile, SonarCloud
124
- Stage 6: /premerge → Update docs, hand off PR to user
125
- Stage 7: /verify → Post-merge CI check on main
126
- ```
127
-
128
- ## Tips
129
-
130
- - **Complete PR body**: Include design doc, decisions log, and test coverage
131
- - **Link everything**: Design doc, decisions log, Beads issue
132
- - **Document security**: OWASP Top 10 review in PR body
133
- - **Test coverage**: Show all test scenarios passing
134
- - **Wait for checks**: Let GitHub Actions, Greptile, SonarCloud run
135
- - **NO auto-merge**: Always wait for /review phase
1
+ ---
2
+ description: Create PR with comprehensive documentation
3
+ mode: code
4
+ ---
5
+
6
+ Push code and create a pull request with full context and documentation links.
7
+
8
+ # Ship
9
+
10
+ This command creates a PR after validation passes.
11
+
12
+ ## Usage
13
+
14
+ ```bash
15
+ /ship
16
+ ```
17
+
18
+ ```
19
+ <HARD-GATE: /ship entry>
20
+ Do NOT create PR until:
21
+ 1. /validate was run in this session with all four outputs shown (type, lint, tests, security)
22
+ 2. All checks confirmed passing — not assumed, not "was passing earlier"
23
+ 3. Beads issue is in_progress
24
+ 4. git branch --show-current output is NOT main or master
25
+ </HARD-GATE>
26
+ ```
27
+
28
+ ## What This Command Does
29
+
30
+ ### Step 1: Verify /validate Passed
31
+ Ensure all four validation checks completed successfully with fresh output in this session.
32
+
33
+ ### Step 2: Freshness Check — Is Branch Still Current?
34
+
35
+ Even though /validate rebased onto the base branch, time may have passed since then (user reviewed design doc, took a break, etc.). This lightweight check catches staleness before pushing.
36
+
37
+ ```bash
38
+ BASE=$(git remote show origin 2>/dev/null | grep 'HEAD branch' | awk '{print $NF}')
39
+ if [ -z "$BASE" ] || [ "$BASE" = "(unknown)" ]; then BASE="master"; fi
40
+ git fetch origin "$BASE" || { echo "✗ Fetch failed — cannot verify freshness"; exit 1; }
41
+ BEHIND=$(git rev-list --count HEAD..origin/"$BASE")
42
+ ```
43
+
44
+ - If `BEHIND > 0`: **STOP**. Print: "$BASE has advanced since /validate ($BEHIND new commits). Run /validate again to rebase and re-check."
45
+ - If `BEHIND = 0`: Continue to push.
46
+ - If fetch fails: the `|| { ...; exit 1; }` guard catches this — **STOP**. Do NOT push without confirming freshness.
47
+
48
+ This is NOT a full rebase — just a check. The rebase happens in /validate where the full test suite runs afterward.
49
+
50
+ ### Step 3: Update Beads
51
+ ```bash
52
+ bd update <id> --status done
53
+ bd sync
54
+ ```
55
+
56
+ ### Step 4: Push Branch
57
+
58
+ Use `--force-with-lease` because `/validate` may have rebased the branch, rewriting history. This is safe: it only forces the push if the remote branch hasn't been updated by someone else since the last fetch.
59
+
60
+ ```bash
61
+ git push --force-with-lease -u origin <branch-name>
62
+ ```
63
+
64
+ ### Step 5: Create PR
65
+
66
+ Use the narrative PR template below. Lead with WHY (Problem/Root Cause/Fix/Value) — this is what reviewers need to understand first. Keep implementation details (test coverage, security review, design doc) in a collapsible section so they're available but don't clutter the summary.
67
+
68
+ If no Beads issue exists (hotfix, external contribution), skip the "Closes" line.
69
+
70
+ ```bash
71
+ gh pr create --title "<type>: <concise description>" --body "$(cat <<'EOF'
72
+ ## Problem
73
+ [What was broken, what need existed, or what user pain this addresses]
74
+
75
+ ## Root Cause
76
+ [Why it happened, why it was missing, or what gap existed]
77
+
78
+ ## Fix
79
+ [What this PR does to solve it — approach, not implementation details]
80
+
81
+ ## Value
82
+ [Who benefits, what improves, what risk is removed]
83
+
84
+ ## Beads
85
+ Closes: <issue-id>
86
+
87
+ <details>
88
+ <summary>Implementation Details</summary>
89
+
90
+ ### Test Coverage
91
+ - Tests: [count] passing
92
+ - Scenarios covered: [list key scenarios]
93
+
94
+ ### Security Review
95
+ - OWASP Top 10: [summary applicable risks and mitigations]
96
+ - Automated scan: [result]
97
+
98
+ ### Design Doc
99
+ See: docs/plans/YYYY-MM-DD-<slug>-design.md
100
+
101
+ ### Decisions Log
102
+ See: docs/plans/YYYY-MM-DD-<slug>-decisions.md (if any undocumented decisions arose during /dev)
103
+
104
+ ### Key Decisions
105
+ [From design doc — 3-5 key decisions with reasoning]
106
+
107
+ ### Documentation Updated
108
+ [List docs updated in this PR, or "None — no doc-facing changes"]
109
+
110
+ ### Validation
111
+ - [x] Type check passing
112
+ - [x] Lint passing (0 errors, 0 warnings)
113
+ - [x] All tests passing
114
+ - [x] Security review completed
115
+
116
+ </details>
117
+
118
+ 🤖 Generated with [Claude Code](https://claude.com/claude-code)
119
+ EOF
120
+ )"
121
+ ```
122
+
123
+ ### Step 6: Record Stage Transition
124
+ ```bash
125
+ bash scripts/beads-context.sh stage-transition <id> ship review
126
+ ```
127
+
128
+ ## Example Output
129
+
130
+ ```
131
+ Validation: /validate passed (all 4 checks fresh output confirmed)
132
+ Freshness: Branch is up-to-date with master
133
+ Beads: Marked done & synced (forge-xyz)
134
+ Pushed: feat/stripe-billing
135
+ PR created: https://github.com/.../pull/123
136
+ - PR body: Problem → Root Cause → Fix → Value (narrative format)
137
+ - Beads linked: forge-xyz
138
+ - Implementation details in collapsible section
139
+
140
+ ⏸️ PR created, awaiting automated checks (Greptile, SonarCloud, GitHub Actions)
141
+
142
+ Next: /review <pr-number> (after automated checks complete)
143
+ ```
144
+
145
+ ## Integration with Workflow
146
+
147
+ ```
148
+ Utility: /status → Understand current context before starting
149
+ Stage 1: /plan → Design intent → research → branch + worktree + task list
150
+ Stage 2: /dev → Implement each task with subagent-driven TDD
151
+ Stage 3: /validate → Type check, lint, tests, security — all fresh output
152
+ Stage 4: /ship → Push + create PR (you are here)
153
+ Stage 5: /review → Address GitHub Actions, Greptile, SonarCloud
154
+ Stage 6: /premerge → Update docs, hand off PR to user
155
+ Stage 7: /verify → Post-merge CI check on main
156
+ ```
157
+
158
+ ## Tips
159
+
160
+ - **Lead with why**: Problem → Root Cause → Fix → Value is what reviewers need first
161
+ - **Collapsible details**: Design doc, decisions log, test coverage go in `<details>` — available but not in the way
162
+ - **Document security**: OWASP Top 10 review in collapsible section
163
+ - **Test coverage**: Show all test scenarios passing
164
+ - **Wait for checks**: Let GitHub Actions, Greptile, SonarCloud run
165
+ - **NO auto-merge**: Always wait for /review phase
@@ -1,150 +1,150 @@
1
- ---
2
- description: Pull issues, metrics, quality gates, and analysis data from SonarCloud
3
- mode: code
4
- ---
5
-
6
- # SonarCloud Query Command
7
-
8
- Pull code quality data from SonarCloud. Requires `SONARCLOUD_TOKEN` environment variable.
9
-
10
- ## Arguments
11
-
12
- - `$ARGUMENTS` - Query type and parameters
13
-
14
- ## Query Types
15
-
16
- | Query | Description | Example |
17
- |-------|-------------|---------|
18
- | `issues <project>` | Get open issues | `/sonarcloud issues my-project` |
19
- | `metrics <project>` | Get code metrics | `/sonarcloud metrics my-project` |
20
- | `gate <project>` | Quality gate status | `/sonarcloud gate my-project` |
21
- | `health <project>` | Full health report | `/sonarcloud health my-project` |
22
- | `pr <project> <pr#>` | PR analysis | `/sonarcloud pr my-project 123` |
23
- | `hotspots <project>` | Security hotspots | `/sonarcloud hotspots my-project` |
24
- | `history <project>` | Analysis history | `/sonarcloud history my-project` |
25
-
26
- ## Filters (append to query)
27
-
28
- | Filter | Description | Example |
29
- |--------|-------------|---------|
30
- | `--branch <name>` | Filter by branch | `--branch develop` |
31
- | `--severity <levels>` | Filter severity | `--severity BLOCKER,CRITICAL` |
32
- | `--type <types>` | Filter issue type | `--type BUG,VULNERABILITY` |
33
- | `--new-code` | Only new code issues | `--new-code` |
34
-
35
- ## Instructions
36
-
37
- 1. Parse the query from `$ARGUMENTS` to determine:
38
- - Query type (issues, metrics, gate, health, pr, hotspots, history)
39
- - Project key
40
- - Optional filters (branch, severity, type, new-code, etc.)
41
- 2. Check for `SONARCLOUD_TOKEN` environment variable. If not set, inform user.
42
- 3. Check for `SONARCLOUD_ORG` environment variable or ask user for organization key.
43
- 4. Execute the appropriate API call using curl or the TypeScript client at `next-app/src/lib/integrations/sonarcloud.ts`
44
- 5. Format and present results clearly:
45
- - For issues: Group by severity/type, show file, line, message
46
- - For metrics: Show as table with metric name and value
47
- - For quality gate: Show pass/fail with failed conditions
48
- - For health: Comprehensive summary with all data
49
- 6. Offer follow-up actions:
50
- - "Show issues in specific file?"
51
- - "Get more details on a specific issue?"
52
- - "Compare with another branch?"
53
-
54
- ## Example Outputs
55
-
56
- ### Issues Query
57
-
58
- ```
59
- 📋 Open Issues for my-project (branch: main)
60
-
61
- Total: 45 issues
62
-
63
- By Severity:
64
- 🔴 BLOCKER: 2
65
- 🟠 CRITICAL: 5
66
- 🟡 MAJOR: 18
67
- ⚪ MINOR: 15
68
- ⚫ INFO: 5
69
-
70
- By Type:
71
- 🐛 BUG: 8
72
- 🔓 VULNERABILITY: 3
73
- 💩 CODE_SMELL: 34
74
-
75
- Top Issues:
76
- 1. [CRITICAL] src/auth/login.ts:42 - SQL injection vulnerability
77
- 2. [BLOCKER] src/api/users.ts:156 - Null pointer dereference
78
- ...
79
- ```
80
-
81
- ### Metrics Query
82
-
83
- ```
84
- 📊 Metrics for my-project
85
-
86
- | Metric | Value |
87
- |--------|-------|
88
- | Lines of Code | 51,234 |
89
- | Coverage | 78.5% |
90
- | Duplications | 3.2% |
91
- | Bugs | 8 |
92
- | Vulnerabilities | 3 |
93
- | Code Smells | 34 |
94
- | Technical Debt | 4d 2h |
95
- | Maintainability | A |
96
- | Reliability | B |
97
- | Security | A |
98
- ```
99
-
100
- ### Quality Gate Query
101
-
102
- ```
103
- 🚦 Quality Gate: ❌ FAILED
104
-
105
- Failed Conditions:
106
- | Metric | Threshold | Actual |
107
- |--------|-----------|--------|
108
- | Coverage on New Code | ≥ 80% | 65.3% |
109
- | New Bugs | = 0 | 2 |
110
-
111
- Passed Conditions:
112
- | Metric | Threshold | Actual |
113
- |--------|-----------|--------|
114
- | New Vulnerabilities | = 0 | 0 |
115
- | Duplicated Lines | ≤ 3% | 1.2% |
116
- ```
117
-
118
- ## API Reference
119
-
120
- Base URL: `https://sonarcloud.io/api`
121
-
122
- ### Key Endpoints
123
-
124
- ```bash
125
- # Issues
126
- curl -H "Authorization: Bearer $TOKEN" \
127
- "https://sonarcloud.io/api/issues/search?organization=$ORG&componentKeys=$PROJECT&resolved=false"
128
-
129
- # Metrics
130
- curl -H "Authorization: Bearer $TOKEN" \
131
- "https://sonarcloud.io/api/measures/component?component=$PROJECT&metricKeys=bugs,vulnerabilities,coverage"
132
-
133
- # Quality Gate
134
- curl -H "Authorization: Bearer $TOKEN" \
135
- "https://sonarcloud.io/api/qualitygates/project_status?projectKey=$PROJECT"
136
-
137
- # Hotspots
138
- curl -H "Authorization: Bearer $TOKEN" \
139
- "https://sonarcloud.io/api/hotspots/search?projectKey=$PROJECT&status=TO_REVIEW"
140
- ```
141
-
142
- ## Full Skill Reference
143
-
144
- See `skills/sonarcloud-analysis/SKILL.md` for complete API documentation including:
145
-
146
- - All endpoints and parameters
147
- - Response structures
148
- - Pagination handling
149
- - Advanced filtering
150
- - Integration patterns
1
+ ---
2
+ description: Pull issues, metrics, quality gates, and analysis data from SonarCloud
3
+ mode: code
4
+ ---
5
+
6
+ # SonarCloud Query Command
7
+
8
+ Pull code quality data from SonarCloud. Requires `SONARCLOUD_TOKEN` environment variable.
9
+
10
+ ## Arguments
11
+
12
+ - `$ARGUMENTS` - Query type and parameters
13
+
14
+ ## Query Types
15
+
16
+ | Query | Description | Example |
17
+ |-------|-------------|---------|
18
+ | `issues <project>` | Get open issues | `/sonarcloud issues my-project` |
19
+ | `metrics <project>` | Get code metrics | `/sonarcloud metrics my-project` |
20
+ | `gate <project>` | Quality gate status | `/sonarcloud gate my-project` |
21
+ | `health <project>` | Full health report | `/sonarcloud health my-project` |
22
+ | `pr <project> <pr#>` | PR analysis | `/sonarcloud pr my-project 123` |
23
+ | `hotspots <project>` | Security hotspots | `/sonarcloud hotspots my-project` |
24
+ | `history <project>` | Analysis history | `/sonarcloud history my-project` |
25
+
26
+ ## Filters (append to query)
27
+
28
+ | Filter | Description | Example |
29
+ |--------|-------------|---------|
30
+ | `--branch <name>` | Filter by branch | `--branch develop` |
31
+ | `--severity <levels>` | Filter severity | `--severity BLOCKER,CRITICAL` |
32
+ | `--type <types>` | Filter issue type | `--type BUG,VULNERABILITY` |
33
+ | `--new-code` | Only new code issues | `--new-code` |
34
+
35
+ ## Instructions
36
+
37
+ 1. Parse the query from `$ARGUMENTS` to determine:
38
+ - Query type (issues, metrics, gate, health, pr, hotspots, history)
39
+ - Project key
40
+ - Optional filters (branch, severity, type, new-code, etc.)
41
+ 2. Check for `SONARCLOUD_TOKEN` environment variable. If not set, inform user.
42
+ 3. Check for `SONARCLOUD_ORG` environment variable or ask user for organization key.
43
+ 4. Execute the appropriate API call using curl or the TypeScript client at `next-app/src/lib/integrations/sonarcloud.ts`
44
+ 5. Format and present results clearly:
45
+ - For issues: Group by severity/type, show file, line, message
46
+ - For metrics: Show as table with metric name and value
47
+ - For quality gate: Show pass/fail with failed conditions
48
+ - For health: Comprehensive summary with all data
49
+ 6. Offer follow-up actions:
50
+ - "Show issues in specific file?"
51
+ - "Get more details on a specific issue?"
52
+ - "Compare with another branch?"
53
+
54
+ ## Example Outputs
55
+
56
+ ### Issues Query
57
+
58
+ ```
59
+ 📋 Open Issues for my-project (branch: main)
60
+
61
+ Total: 45 issues
62
+
63
+ By Severity:
64
+ 🔴 BLOCKER: 2
65
+ 🟠 CRITICAL: 5
66
+ 🟡 MAJOR: 18
67
+ ⚪ MINOR: 15
68
+ ⚫ INFO: 5
69
+
70
+ By Type:
71
+ 🐛 BUG: 8
72
+ 🔓 VULNERABILITY: 3
73
+ 💩 CODE_SMELL: 34
74
+
75
+ Top Issues:
76
+ 1. [CRITICAL] src/auth/login.ts:42 - SQL injection vulnerability
77
+ 2. [BLOCKER] src/api/users.ts:156 - Null pointer dereference
78
+ ...
79
+ ```
80
+
81
+ ### Metrics Query
82
+
83
+ ```
84
+ 📊 Metrics for my-project
85
+
86
+ | Metric | Value |
87
+ |--------|-------|
88
+ | Lines of Code | 51,234 |
89
+ | Coverage | 78.5% |
90
+ | Duplications | 3.2% |
91
+ | Bugs | 8 |
92
+ | Vulnerabilities | 3 |
93
+ | Code Smells | 34 |
94
+ | Technical Debt | 4d 2h |
95
+ | Maintainability | A |
96
+ | Reliability | B |
97
+ | Security | A |
98
+ ```
99
+
100
+ ### Quality Gate Query
101
+
102
+ ```
103
+ 🚦 Quality Gate: ❌ FAILED
104
+
105
+ Failed Conditions:
106
+ | Metric | Threshold | Actual |
107
+ |--------|-----------|--------|
108
+ | Coverage on New Code | ≥ 80% | 65.3% |
109
+ | New Bugs | = 0 | 2 |
110
+
111
+ Passed Conditions:
112
+ | Metric | Threshold | Actual |
113
+ |--------|-----------|--------|
114
+ | New Vulnerabilities | = 0 | 0 |
115
+ | Duplicated Lines | ≤ 3% | 1.2% |
116
+ ```
117
+
118
+ ## API Reference
119
+
120
+ Base URL: `https://sonarcloud.io/api`
121
+
122
+ ### Key Endpoints
123
+
124
+ ```bash
125
+ # Issues
126
+ curl -H "Authorization: Bearer $TOKEN" \
127
+ "https://sonarcloud.io/api/issues/search?organization=$ORG&componentKeys=$PROJECT&resolved=false"
128
+
129
+ # Metrics
130
+ curl -H "Authorization: Bearer $TOKEN" \
131
+ "https://sonarcloud.io/api/measures/component?component=$PROJECT&metricKeys=bugs,vulnerabilities,coverage"
132
+
133
+ # Quality Gate
134
+ curl -H "Authorization: Bearer $TOKEN" \
135
+ "https://sonarcloud.io/api/qualitygates/project_status?projectKey=$PROJECT"
136
+
137
+ # Hotspots
138
+ curl -H "Authorization: Bearer $TOKEN" \
139
+ "https://sonarcloud.io/api/hotspots/search?projectKey=$PROJECT&status=TO_REVIEW"
140
+ ```
141
+
142
+ ## Full Skill Reference
143
+
144
+ See `skills/sonarcloud-analysis/SKILL.md` for complete API documentation including:
145
+
146
+ - All endpoints and parameters
147
+ - Response structures
148
+ - Pagination handling
149
+ - Advanced filtering
150
+ - Integration patterns