* 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>
161 lines
5.2 KiB
Markdown
161 lines
5.2 KiB
Markdown
# Design: /gsd-ultraplan-phase [BETA]
|
||
|
||
**Date:** 2026-04-17
|
||
**Status:** Approved — ready for implementation
|
||
**Branch:** Beta feature, isolated from core plan pipeline
|
||
|
||
---
|
||
|
||
## Summary
|
||
|
||
A standalone `/gsd-ultraplan-phase` command that offloads GSD's research+plan phase to Claude Code's ultraplan cloud infrastructure. The plan drafts remotely while the terminal stays free, is reviewed in a rich browser UI with inline comments, then imports back into GSD via the existing `/gsd-import --from` workflow.
|
||
|
||
This is a **beta of a beta**: ultraplan itself is in research preview, so this command is intentionally isolated from the core `/gsd-plan-phase` pipeline to prevent breakage if ultraplan changes.
|
||
|
||
---
|
||
|
||
## Scope
|
||
|
||
**In scope:**
|
||
- New `commands/gsd/ultraplan-phase.md` command
|
||
- New `gsd-core/workflows/ultraplan-phase.md` workflow
|
||
- Runtime gate: Claude Code only (checks `$CLAUDE_CODE_VERSION`)
|
||
- Builds structured ultraplan prompt from GSD phase context
|
||
- Return path via existing `/gsd-import --from <file>` (no new import logic)
|
||
|
||
**Out of scope (future):**
|
||
- Parallel next-phase planning during `/gsd-execute-phase`
|
||
- Auto-detection of ultraplan's saved file path
|
||
- Text mode / non-interactive fallback
|
||
|
||
---
|
||
|
||
## Architecture
|
||
|
||
```text
|
||
/gsd-ultraplan-phase [phase]
|
||
│
|
||
├─ Runtime gate (CLAUDE_CODE_VERSION check)
|
||
├─ gsd-sdk query init.plan-phase → phase context
|
||
├─ Build ultraplan prompt (phase scope + requirements + research)
|
||
├─ Display return-path instructions card
|
||
└─ /ultraplan <prompt>
|
||
│
|
||
[cloud: user reviews, comments, revises]
|
||
│
|
||
[browser: Approve → teleport back to terminal]
|
||
│
|
||
[terminal: Cancel → saves to file]
|
||
│
|
||
/gsd-import --from <saved file path>
|
||
│
|
||
├─ Conflict detection
|
||
├─ GSD format conversion
|
||
├─ gsd-plan-checker validation
|
||
├─ ROADMAP.md update
|
||
└─ Commit
|
||
```
|
||
|
||
---
|
||
|
||
## Command File (`commands/gsd/ultraplan-phase.md`)
|
||
|
||
Frontmatter:
|
||
- `name: gsd:ultraplan-phase`
|
||
- `description:` includes `[BETA]` marker
|
||
- `argument-hint: [phase-number]`
|
||
- `allowed-tools:` Read, Bash, Glob, Grep
|
||
- References: `@~/.claude/gsd-core/workflows/ultraplan-phase.md`, ui-brand
|
||
|
||
---
|
||
|
||
## Workflow Steps
|
||
|
||
### 1. Banner
|
||
Display GSD `► ULTRAPLAN PHASE [BETA]` banner.
|
||
|
||
### 2. Runtime Gate
|
||
```bash
|
||
echo $CLAUDE_CODE_VERSION
|
||
```
|
||
If unset/empty: print error and exit.
|
||
```text
|
||
⚠ /gsd-ultraplan-phase requires Claude Code.
|
||
/ultraplan is not available in this runtime.
|
||
Use /gsd-plan-phase for local planning.
|
||
```
|
||
|
||
### 3. Initialize
|
||
```bash
|
||
INIT=$(gsd-sdk query init.plan-phase "$PHASE")
|
||
```
|
||
Parse: phase number, phase name, phase slug, phase dir, roadmap path, requirements path, research path.
|
||
|
||
If no `.planning/` exists: error — run `/gsd-new-project` first.
|
||
|
||
### 4. Build Ultraplan Prompt
|
||
Construct a prompt that includes:
|
||
- Phase identification: `"Plan phase {N}: {phase name}"`
|
||
- Phase scope block from ROADMAP.md
|
||
- Requirements summary (if REQUIREMENTS.md exists)
|
||
- Research summary (if RESEARCH.md exists — reduces cloud redundancy)
|
||
- Output format instruction: produce a GSD PLAN.md with standard frontmatter fields
|
||
|
||
### 5. Return-Path Instructions Card
|
||
Display prominently before triggering (visible in terminal scroll-back):
|
||
```text
|
||
When ◆ ultraplan ready:
|
||
1. Open the session link in your browser
|
||
2. Review, comment, and revise the plan
|
||
3. When satisfied: "Approve plan and teleport back to terminal"
|
||
4. At the terminal dialog: choose Cancel (saves plan to file)
|
||
5. Run: /gsd-import --from <the file path Claude prints>
|
||
```
|
||
|
||
### 6. Trigger Ultraplan
|
||
```text
|
||
/ultraplan <constructed prompt>
|
||
```
|
||
|
||
---
|
||
|
||
## Return Path
|
||
|
||
No new code needed. The user runs `/gsd-import --from <path>` after ultraplan saves the file. That workflow handles everything: conflict detection, GSD format conversion, plan-checker, ROADMAP update, commit.
|
||
|
||
---
|
||
|
||
## Runtime Detection
|
||
|
||
`$CLAUDE_CODE_VERSION` is set by Claude Code in the shell environment. If unset, the session is not Claude Code (Gemini CLI, Copilot, etc.) and `/ultraplan` does not exist.
|
||
|
||
---
|
||
|
||
## Pricing
|
||
|
||
Ultraplan runs as a standard Claude Code on the web session. For Pro/Max subscribers this is included in the subscription — no extra usage billing (unlike ultrareview which bills $5–20/run). No cost gate needed.
|
||
|
||
---
|
||
|
||
## Beta Markers
|
||
|
||
- `[BETA]` in command description
|
||
- `⚠ BETA` in workflow banner
|
||
- Comment in workflow noting ultraplan is in research preview
|
||
|
||
---
|
||
|
||
## Test Coverage
|
||
|
||
`tests/ultraplan-phase.test.cjs` — structural assertions covering:
|
||
- File existence (command + workflow)
|
||
- Command frontmatter completeness (name, description with `[BETA]`, argument-hint)
|
||
- Command references workflow
|
||
- Workflow has runtime gate (`CLAUDE_CODE_VERSION`)
|
||
- Workflow has beta warning
|
||
- Workflow has init step (gsd-sdk query)
|
||
- Workflow builds ultraplan prompt with phase context
|
||
- Workflow triggers `/ultraplan`
|
||
- Workflow has return-path instructions (Cancel path, `/gsd-import --from`)
|
||
- Workflow does NOT directly implement plan writing (delegates to `/gsd-import`)
|