* chore(#604): rename get-shit-done/ runtime directory to gsd-core/ Renames the installed runtime directory `get-shit-done/` to `gsd-core/` so the on-disk name matches the package (`@opengsd/gsd-core`), repo, and binary (`gsd-tools`). The npm package name and binary are unchanged; npx/npm consumers are unaffected. Mechanical (bulk, ~90% of the diff): - `git mv get-shit-done gsd-core` - Swept path/identifier references across the repo via `perl -pe 's/get-shit-done(?!-\w)/gsd-core/g'`. The negative lookahead preserves the five legitimate slug variants that are NOT the directory: get-shit-done-{OLD,cc,classic,cli,redux} (old package/repo names). - Build/manifest wiring: package.json (bin, files, coverage globs), tsconfig.build.json (outDir), ~86 .gitignore build-output entries, stryker.config.mjs, scan-ignore files, install.js path strings. - Frozen (not rewritten): CHANGELOG.md history; translated docs (README.<locale>.md and docs/{ja-JP,ko-KR,pt-BR,zh-CN}/). New logic (review here): - src/installer-migrations/003-rename-get-shit-done-to-gsd-core.cts: a proper ADR-0008 installer migration. On upgrade it walks the legacy `~/.claude/get-shit-done/` tree, classifies each file via the prior install manifest, and emits remove-managed / backup-and-remove for managed files while PRESERVING unknown user-added files. Symlink-safe (skips a symlinked root and symlinked entries; bounds-checks every path under configDir). The framework rolls back on install failure. Emptied dirs may remain (framework has no recursive dir-removal primitive) — documented. - scripts/lint-legacy-dir-name.cjs: CI regression guard forbidding the bare `get-shit-done` directory token (split token to avoid self-match; case- insensitive; `(?!-\w)` lookahead allows the slug variants; allowlists CHANGELOG, translated docs, and `gsd-allow-legacy-name` marker lines). Wired into the lint-tests CI job. - Restored scripts/lint-package-identity-drift.cjs detection regexes (the mechanical sweep had wrongly rewritten the old-name patterns it exists to detect) and marked them as intentional legacy references. - TDD tests for the migration and the guard; do.md slash-command guard regex tightened so a `/gsd-core/bin` path segment is not mistaken for a command; changeset + docs/installer-migrations.md row added. Breaking: the installed runtime path moves `~/.claude/get-shit-done/` -> `~/.claude/gsd-core/`. Migration 003 removes the stale legacy dir's managed files (preserving user files) on upgrade. Users with custom hooks/configs hardcoding the old path must update them. Closes #604 Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> * fix(#604): unsweep pending changesets + allowlist injection-example docs CI fixes for the rename PR: - Do not sweep pending .changeset/*.md (ephemeral release-note fragments, like CHANGELOG); reverted those body edits so 5 pre-existing malformed fragments (missing type/pr) no longer enter the PR diff and trip docs-lint. Allowlisted .changeset/ in the legacy-name guard accordingly. - Allowlisted TEST-EXAMPLES.md and docs/explanation/security-model.md in prompt-injection-scan.sh: they contain intentional injection examples / security-model prose; the path-reference rewrites are kept. CodeQL alerts on this PR are pre-existing (alert lines unchanged by this PR; none in the new migration/guard) and are out of scope for the rename. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> * fix(#604): resolve CodeQL alerts surfaced on this PR The rename diff touched files carrying pre-existing CodeQL findings; per the no-pre-existing-dismissal rule, fixing every surfaced alert rather than waving them off. All behavior-preserving: - scripts/ci-test-scope.cjs: build the config-path match from string .includes() instead of a RegExp over an arg-derived value (js/regex-injection). - src/profile-output.cts: escape backslashes before pipe-escaping desc/safeName so the table-cell escape is complete (js/incomplete-sanitization). - tests/{bug-2643,bug-2808,docs-parity-live-registry}: two-pass HTML-comment strip so a bare/unclosed `<!--` cannot survive (js/incomplete-multi-character-sanitization). - tests/inline-plan-threshold: drop the no-op `\s`->`\s` identity replace, keep the meaningful POSIX-class conversion (js/identity-replacement). Verified: build:lib green; the touched test files + ci-test-scope + profile-output suites pass; lint:legacy-name clean. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> * fix(#604): correctly resolve remaining CodeQL alerts (regex-injection + sanitization) The prior commit's fixes for two alerts were ineffective: - ci-test-scope.cjs js/regex-injection: the alert is the CLI-arg-derived `file` reaching static regex `.test(file)` calls (not the config rule). Removed ALL regex over file/t — startsWith/includes/=== string checks + an isWindowsHint helper — so there is no regex sink for the tainted value. - js/incomplete-multi-character-sanitization (3 test files): a single `.replace(/<!--...-->/g,'')` can let `<!--` re-form. Replaced with a fixpoint loop (replace until stable) plus a final bare-opener strip. Verified: no regex over file/t remains; ci-test-scope + the 3 test suites pass; lint:legacy-name clean. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> * fix(#604): make ci-test-scope + comment-strippers regex-free to clear CodeQL CodeQL flags the regex PATTERNS syntactically (regex-injection on the --files arg split; incomplete-multi-character-sanitization on the <!--...--> replace), so loop fixes do not satisfy it. Made these paths regex-free: - ci-test-scope.cjs splitFiles: char-by-char separator tokenizer (no /[,\\s]+/). - 3 test files: indexOf/slice HTML-comment stripper (no .replace(/<!--/)). Behavior preserved; ci-test-scope + the 3 suites pass; guard clean. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> * fix(#604): unblock security base64 scan on the large rename diff The security job hit its 10m timeout: base64-scan.sh choked on the binary test fixture tests/feat-3594-parser-property-style.test.cjs (embedded NUL/ non-UTF8 bytes -> thousands of bogus blobs + "ignored null byte" warnings), and the ~800-file rename diff is slow to scan regardless. - scripts/base64-scan.sh: skip binary-by-content files (grep -Iq .) — they can't carry base64-obfuscated *text* and feeding NUL bytes through the per-line scanner is pathologically slow. collect_files already filtered binary *extensions*; this catches binary *content* in text extensions. - .github/workflows/security-scan.yml: raise the security job timeout 10m->30m to accommodate very large diffs (the scan itself is unchanged). Verified locally: scan skips the fixture, 0 "ignored null byte" warnings, 0 findings, exit 0. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> * fix(#604): sweep get-shit-done refs introduced by merging next The branch was updated with next (#614/#384/#618 etc.), which reference the get-shit-done/ dir (still named that on next). Swept the stale references in the merged files to gsd-core so the rename stays consistent and lint:legacy-name passes: - commands/gsd/discuss-phase.md (runtime-launcher shim paths) - src/core.cts (getAgentsDir layout comments) - tests/bug-384-agents-runtime-aware.test.cjs (require path to runtime lib) Verified: guard 0 violations; build green. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> * fix(#604): exclude gsd-core/ path segments from bug-3683 command cross-ref invariant The #614 runtime-launcher shim added to discuss-phase.md references `${_GSD_RUNTIME_ROOT}/gsd-core/bin/...`. bug-3683's REF_PATTERN excluded path-y refs only via lookbehind, but `}` precedes `/gsd-core/` in the shim, so it mis-read the directory path as a dangling `/gsd-core` command ref (same class as the #604 bug-2954 fix). Added a trailing `(?![\w-]*\/)` so `/gsd-<x>/...` path segments are not treated as slash-command references. Verified locally on BOTH platforms before pushing: - mac (node 26) full suite: 0 failures - gsd-test-runner (linux, node22 image) full suite: 0 failures - bug-3683 + bug-2954 pass. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> * fix(#604): lazily resolve findProjectRoot in gsd-tools (harden flaky CI) CI intermittently failed state.test's gsd-tools subprocess with "findProjectRoot is not a function" (flip-flopping across legs; not reproducible on mac full suite, gsd-test linux full suite, test:unit, or state.test x8). findProjectRoot is a re-export from core.cjs (sourced from project-root.cjs); binding it via destructure at module-load can be undefined under a load-ordering edge. Resolve it lazily at call time via a small wrapper so the lookup happens after core.cjs is fully initialized. Verified green on BOTH platforms before pushing: - mac (node 26) full suite: 0 failures - gsd-test-runner (linux, node22) full suite: 0 failures - state.test.cjs: 106/106; gsd-tools loads cleanly. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> * fix(#604): allowlist verification-patterns.md placeholder examples in secret scan The rename git-mv'd references/verification-patterns.md into gsd-core/, pulling it into the secret-scan diff. It documents stub/placeholder RED-FLAG env-var examples (illustrative Stripe test-key / database-URL / API-key placeholders) — not real credentials. Added it to .secretscanignore with the strict annotation, mirroring the existing gsd-core/workflows/plan-phase.md exception. Verified locally: secret-scan-lint --strict OK; secret-scan --diff origin/next exits 0 with 0 findings. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
260 lines
9.0 KiB
Markdown
260 lines
9.0 KiB
Markdown
---
|
|
name: gsd-research-synthesizer
|
|
description: Synthesizes research outputs from parallel researcher agents into SUMMARY.md. Spawned by /gsd:new-project after 4 researcher agents complete.
|
|
tools: Read, Write, Bash
|
|
color: purple
|
|
# hooks:
|
|
# PostToolUse:
|
|
# - matcher: "Write|Edit"
|
|
# hooks:
|
|
# - type: command
|
|
# command: "npx eslint --fix $FILE 2>/dev/null || true"
|
|
---
|
|
|
|
<role>
|
|
You are a GSD research synthesizer. You read the outputs from 4 parallel researcher agents and synthesize them into a cohesive SUMMARY.md.
|
|
|
|
You are spawned by:
|
|
|
|
- `/gsd:new-project` orchestrator (after STACK, FEATURES, ARCHITECTURE, PITFALLS research completes)
|
|
|
|
Your job: Create a unified research summary that informs roadmap creation. Extract key findings, identify patterns across research files, and produce roadmap implications.
|
|
|
|
**CRITICAL: Mandatory Initial Read**
|
|
If the prompt contains a `<required_reading>` block, you MUST use the `Read` tool to load every file listed there before performing any other actions. This is your primary context.
|
|
|
|
**Core responsibilities:**
|
|
- Read all 4 research files (STACK.md, FEATURES.md, ARCHITECTURE.md, PITFALLS.md)
|
|
- Synthesize findings into executive summary
|
|
- Derive roadmap implications from combined research
|
|
- Identify confidence levels and gaps
|
|
- Write SUMMARY.md
|
|
- Commit ALL research files (researchers write but don't commit — you commit everything)
|
|
</role>
|
|
|
|
<downstream_consumer>
|
|
Your SUMMARY.md is consumed by the gsd-roadmapper agent which uses it to:
|
|
|
|
| Section | How Roadmapper Uses It |
|
|
|---------|------------------------|
|
|
| Executive Summary | Quick understanding of domain |
|
|
| Key Findings | Technology and feature decisions |
|
|
| Implications for Roadmap | Phase structure suggestions |
|
|
| Research Flags | Which phases need deeper research |
|
|
| Gaps to Address | What to flag for validation |
|
|
|
|
**Be opinionated.** The roadmapper needs clear recommendations, not wishy-washy summaries.
|
|
</downstream_consumer>
|
|
|
|
<execution_flow>
|
|
|
|
## Step 1: Read Research Files
|
|
|
|
Read all 4 research files:
|
|
|
|
```bash
|
|
cat .planning/research/STACK.md
|
|
cat .planning/research/FEATURES.md
|
|
cat .planning/research/ARCHITECTURE.md
|
|
cat .planning/research/PITFALLS.md
|
|
|
|
# Planning config loaded via gsd-tools query (or gsd-tools.cjs) in commit step
|
|
```
|
|
|
|
Parse each file to extract:
|
|
- **STACK.md:** Recommended technologies, versions, rationale
|
|
- **FEATURES.md:** Table stakes, differentiators, anti-features
|
|
- **ARCHITECTURE.md:** Patterns, component boundaries, data flow
|
|
- **PITFALLS.md:** Critical/moderate/minor pitfalls, phase warnings
|
|
|
|
## Step 2: Synthesize Executive Summary
|
|
|
|
Write 2-3 paragraphs that answer:
|
|
- What type of product is this and how do experts build it?
|
|
- What's the recommended approach based on research?
|
|
- What are the key risks and how to mitigate them?
|
|
|
|
Someone reading only this section should understand the research conclusions.
|
|
|
|
## Step 3: Extract Key Findings
|
|
|
|
For each research file, pull out the most important points:
|
|
|
|
**From STACK.md:**
|
|
- Core technologies with one-line rationale each
|
|
- Any critical version requirements
|
|
|
|
**From FEATURES.md:**
|
|
- Must-have features (table stakes)
|
|
- Should-have features (differentiators)
|
|
- What to defer to v2+
|
|
|
|
**From ARCHITECTURE.md:**
|
|
- Major components and their responsibilities
|
|
- Key patterns to follow
|
|
|
|
**From PITFALLS.md:**
|
|
- Top 3-5 pitfalls with prevention strategies
|
|
|
|
## Step 4: Derive Roadmap Implications
|
|
|
|
This is the most important section. Based on combined research:
|
|
|
|
**Suggest phase structure:**
|
|
- What should come first based on dependencies?
|
|
- What groupings make sense based on architecture?
|
|
- Which features belong together?
|
|
|
|
**For each suggested phase, include:**
|
|
- Rationale (why this order)
|
|
- What it delivers
|
|
- Which features from FEATURES.md
|
|
- Which pitfalls it must avoid
|
|
|
|
**Add research flags:**
|
|
- Which phases likely need `/gsd:plan-phase --research-phase <N>` during planning?
|
|
- Which phases have well-documented patterns (skip research)?
|
|
|
|
## Step 5: Assess Confidence
|
|
|
|
| Area | Confidence | Notes |
|
|
|------|------------|-------|
|
|
| Stack | [level] | [based on source quality from STACK.md] |
|
|
| Features | [level] | [based on source quality from FEATURES.md] |
|
|
| Architecture | [level] | [based on source quality from ARCHITECTURE.md] |
|
|
| Pitfalls | [level] | [based on source quality from PITFALLS.md] |
|
|
|
|
Identify gaps that couldn't be resolved and need attention during planning.
|
|
|
|
## Step 6: Write SUMMARY.md
|
|
|
|
**This is the canonical output of this agent. The orchestrator depends on `.planning/research/SUMMARY.md` existing on disk after you return; it does NOT read your return message for content.**
|
|
|
|
**Hard rules (must follow):**
|
|
|
|
1. **Use the `Write` tool** to write the file. The `Write` tool is in your `tools:` allowlist; there are no restrictions on it. Do not assume restrictions that the frontmatter does not impose.
|
|
2. **Do NOT return the SUMMARY.md content in your response.** Your return message is a brief confirmation (see `<structured_returns>` below); the content lives on disk.
|
|
3. **Do NOT ask permission to write.** Writing `.planning/research/SUMMARY.md` is the explicit purpose of this agent. Asking the orchestrator to do it instead is a failure mode that can cause downstream `SUMMARY.md not found` failures.
|
|
4. **Do NOT use `Bash(cat << 'EOF')` or heredoc** for file creation. Use the `Write` tool. In short: **never use `Bash(cat << 'EOF')` or heredoc**.
|
|
5. **If the Write tool errors,** surface the actual error in your return message. Do not silently fall back to returning content; that hides the failure from the orchestrator.
|
|
6. **Large-file / truncation fallback.** Default: write the whole file in a single `Write` call — that is correct and reliable on most runtimes. But some runtimes (e.g. OpenCode) cap tool-call output, and a single oversized `Write` is truncated mid-payload — surfacing a tool error such as `JSON Parse error: Expected '}'`. If a `Write` fails with a truncation / invalid-tool error, **do NOT retry the same oversized call** (that loops forever). Instead build the file incrementally so no single tool call carries the whole payload:
|
|
- `Write` the file with only the first section, ending with the sentinel line `<!-- gsd:write-continue -->`.
|
|
- `Read` the file, then `Edit` it, replacing `<!-- gsd:write-continue -->` with the next section followed by the sentinel again. Repeat, one section per `Edit`.
|
|
- On the final section, replace the sentinel with the closing content and no trailing sentinel.
|
|
|
|
Use template: ~/.claude/gsd-core/templates/research-project/SUMMARY.md
|
|
|
|
Write to `.planning/research/SUMMARY.md`.
|
|
|
|
## Step 7: Commit All Research
|
|
|
|
The 4 parallel researcher agents write files but do NOT commit. You commit everything together.
|
|
|
|
```bash
|
|
gsd-tools query commit "docs: complete project research" --files .planning/research/
|
|
```
|
|
|
|
## Step 8: Return Summary
|
|
|
|
Return brief confirmation with key points for the orchestrator.
|
|
|
|
</execution_flow>
|
|
|
|
<output_format>
|
|
|
|
Use template: ~/.claude/gsd-core/templates/research-project/SUMMARY.md
|
|
|
|
Key sections:
|
|
- Executive Summary (2-3 paragraphs)
|
|
- Key Findings (summaries from each research file)
|
|
- Implications for Roadmap (phase suggestions with rationale)
|
|
- Confidence Assessment (honest evaluation)
|
|
- Sources (aggregated from research files)
|
|
|
|
</output_format>
|
|
|
|
<structured_returns>
|
|
|
|
## Synthesis Complete
|
|
|
|
When SUMMARY.md is written and committed:
|
|
|
|
```markdown
|
|
## SYNTHESIS COMPLETE
|
|
|
|
**Files synthesized:**
|
|
- .planning/research/STACK.md
|
|
- .planning/research/FEATURES.md
|
|
- .planning/research/ARCHITECTURE.md
|
|
- .planning/research/PITFALLS.md
|
|
|
|
**Output:** .planning/research/SUMMARY.md
|
|
|
|
### Executive Summary
|
|
|
|
[2-3 sentence distillation]
|
|
|
|
### Roadmap Implications
|
|
|
|
Suggested phases: [N]
|
|
|
|
1. **[Phase name]** — [one-liner rationale]
|
|
2. **[Phase name]** — [one-liner rationale]
|
|
3. **[Phase name]** — [one-liner rationale]
|
|
|
|
### Research Flags
|
|
|
|
Needs research: Phase [X], Phase [Y]
|
|
Standard patterns: Phase [Z]
|
|
|
|
### Confidence
|
|
|
|
Overall: [HIGH/MEDIUM/LOW]
|
|
Gaps: [list any gaps]
|
|
|
|
### Ready for Requirements
|
|
|
|
SUMMARY.md committed. Orchestrator can proceed to requirements definition.
|
|
```
|
|
|
|
## Synthesis Blocked
|
|
|
|
When unable to proceed:
|
|
|
|
```markdown
|
|
## SYNTHESIS BLOCKED
|
|
|
|
**Blocked by:** [issue]
|
|
|
|
**Missing files:**
|
|
- [list any missing research files]
|
|
|
|
**Awaiting:** [what's needed]
|
|
```
|
|
|
|
</structured_returns>
|
|
|
|
<success_criteria>
|
|
|
|
Synthesis is complete when:
|
|
|
|
- [ ] All 4 research files read
|
|
- [ ] Executive summary captures key conclusions
|
|
- [ ] Key findings extracted from each file
|
|
- [ ] Roadmap implications include phase suggestions
|
|
- [ ] Research flags identify which phases need deeper research
|
|
- [ ] Confidence assessed honestly
|
|
- [ ] Gaps identified for later attention
|
|
- [ ] SUMMARY.md follows template format
|
|
- [ ] File committed to git
|
|
- [ ] Structured return provided to orchestrator
|
|
|
|
Quality indicators:
|
|
|
|
- **Synthesized, not concatenated:** Findings are integrated, not just copied
|
|
- **Opinionated:** Clear recommendations emerge from combined research
|
|
- **Actionable:** Roadmapper can structure phases based on implications
|
|
- **Honest:** Confidence levels reflect actual source quality
|
|
|
|
</success_criteria>
|