* 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>
251 lines
9.9 KiB
JavaScript
251 lines
9.9 KiB
JavaScript
'use strict';
|
|
|
|
/**
|
|
* Regression tests for issue #26 (open-gsd/gsd-core).
|
|
* Three generator-pattern drift items: W005 phaseDirNameRe,
|
|
* W006-archived regex constants (PHASE_TOKEN_FROM_DIR_RE, MILESTONE_ARCHIVE_DIR_RE),
|
|
* I001 canonicalPlanStem.
|
|
*
|
|
* After the generator migration, all three helpers are sourced from
|
|
* validate.cjs. If they diverge from validate.ts, these
|
|
* tests go RED.
|
|
*
|
|
* References:
|
|
* - Issue #26 (open-gsd/gsd-core) — three drift items + reproducer
|
|
* - ADR-3524 (docs/adr/3524-cjs-sdk-hard-seam.md)
|
|
* - PR #154 (issue #4) — generator pattern precedent
|
|
* - PR #156 (issue #6) — validate.ts generator scaffolding (#26 extends this)
|
|
* - Original PR #3479 — first validate.ts false-positive fix (never reached CJS)
|
|
*/
|
|
|
|
const { describe, test, before, after } = require('node:test');
|
|
const assert = require('node:assert/strict');
|
|
const fs = require('node:fs');
|
|
const path = require('node:path');
|
|
const os = require('node:os');
|
|
|
|
const { runGsdTools, cleanup } = require('./helpers.cjs');
|
|
|
|
function mkplanning(base) {
|
|
const planningDir = path.join(base, '.planning');
|
|
const phasesDir = path.join(planningDir, 'phases');
|
|
fs.mkdirSync(phasesDir, { recursive: true });
|
|
return { planningDir, phasesDir };
|
|
}
|
|
|
|
function writeProjectMd(planningDir) {
|
|
fs.writeFileSync(
|
|
path.join(planningDir, 'PROJECT.md'),
|
|
'# Project\n\n## What This Is\nTest.\n\n## Core Value\nTest.\n\n## Requirements\nTest.\n',
|
|
);
|
|
}
|
|
|
|
function writeStateMd(planningDir, phase) {
|
|
fs.writeFileSync(
|
|
path.join(planningDir, 'STATE.md'),
|
|
`# State\n\n**Current Phase:** ${phase}\n**Status:** In progress\n`,
|
|
);
|
|
}
|
|
|
|
function writeConfigJson(planningDir) {
|
|
fs.writeFileSync(
|
|
path.join(planningDir, 'config.json'),
|
|
JSON.stringify({ model_profile: 'balanced' }),
|
|
);
|
|
}
|
|
|
|
// ── Drift Item W005: phaseDirNameRe ──────────────────────────────────────────
|
|
//
|
|
// Issue #26 reproducer (verbatim):
|
|
// mkdir -p .planning/phases/999.1-foo
|
|
// echo "# Roadmap" > .planning/ROADMAP.md
|
|
// node .claude/gsd-core/bin/gsd-tools.cjs validate health
|
|
// # Bug: emits W005 about 999.1-foo not following NN-name format
|
|
//
|
|
// verify.cjs must consume phaseDirNameRe from validate.cjs so
|
|
// the regex /^\d{2,}(?:\.\d+)*-[\w-]+$/ is the single source of truth.
|
|
|
|
describe('Drift item W005 — phaseDirNameRe: 999.X-name dirs must not trigger W005', () => {
|
|
let tmpDir;
|
|
|
|
before(() => {
|
|
tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), 'gsd-26-d1-'));
|
|
const { planningDir, phasesDir } = mkplanning(tmpDir);
|
|
writeProjectMd(planningDir);
|
|
writeStateMd(planningDir, '999.1');
|
|
writeConfigJson(planningDir);
|
|
|
|
fs.writeFileSync(
|
|
path.join(planningDir, 'ROADMAP.md'),
|
|
'# Roadmap\n\n- [x] **Phase 999.1:** Long Phase\n\n### Phase 999.1: Long Phase\n',
|
|
);
|
|
|
|
// Exact reproducer from issue #26
|
|
fs.mkdirSync(path.join(phasesDir, '999.1-foo'), { recursive: true });
|
|
});
|
|
|
|
after(() => { cleanup(tmpDir); });
|
|
|
|
test('no W005 for 999.1-foo (multi-digit sub-phase prefix)', () => {
|
|
const result = runGsdTools(['validate', 'health', '--json'], tmpDir);
|
|
assert.strictEqual(result.success, true, `unexpected failure: ${result.error}`);
|
|
const data = JSON.parse(result.output);
|
|
const w005 = (data.warnings ?? []).filter((w) => w.code === 'W005');
|
|
assert.strictEqual(w005.length, 0,
|
|
`Expected zero W005 for 999.1-foo, got: ${JSON.stringify(w005)}`);
|
|
});
|
|
|
|
test('phaseDirNameRe is exported from validate.cjs', () => {
|
|
const gen = require('../gsd-core/bin/lib/validate.cjs');
|
|
assert.ok(gen.phaseDirNameRe instanceof RegExp,
|
|
'validate.cjs must export phaseDirNameRe as a RegExp');
|
|
const re = gen.phaseDirNameRe;
|
|
assert.ok(re.test('01-setup'), 'should accept 01-setup');
|
|
assert.ok(re.test('999-longphase'), 'should accept 999-longphase (3-digit prefix)');
|
|
assert.ok(re.test('999.1-foo'), 'should accept 999.1-foo (sub-phase)');
|
|
assert.ok(!re.test('1-shortname'), 'should reject single-digit prefix');
|
|
});
|
|
});
|
|
|
|
// ── Drift Item W006-archived: PHASE_TOKEN_FROM_DIR_RE / MILESTONE_ARCHIVE_DIR_RE ─
|
|
//
|
|
// forEachArchivedPhaseToken() in verify.cjs uses two inline regex constants.
|
|
// After migration both are sourced from validate.cjs:
|
|
// PHASE_TOKEN_FROM_DIR_RE — extracts token from dir name like "64-auth-service"
|
|
// MILESTONE_ARCHIVE_DIR_RE — matches archive dirs like "v1.0-phases"
|
|
//
|
|
// Test: phase 64 was archived to milestones/v1.0-phases/64-auth-service/.
|
|
// Without correct archive detection, W006 fires for "Phase 64 in ROADMAP.md
|
|
// but no directory on disk".
|
|
|
|
describe('Drift item W006-archived — MILESTONE_ARCHIVE_DIR_RE and PHASE_TOKEN_FROM_DIR_RE', () => {
|
|
let tmpDir;
|
|
|
|
before(() => {
|
|
tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), 'gsd-26-d2-'));
|
|
const { planningDir, phasesDir } = mkplanning(tmpDir);
|
|
writeProjectMd(planningDir);
|
|
writeStateMd(planningDir, '65');
|
|
writeConfigJson(planningDir);
|
|
|
|
fs.writeFileSync(
|
|
path.join(planningDir, 'ROADMAP.md'),
|
|
[
|
|
'# Roadmap',
|
|
'',
|
|
'- [x] **Phase 65:** Current Work',
|
|
'',
|
|
'### Phase 65: Current Work',
|
|
'',
|
|
'<details>',
|
|
'<summary>Milestone v1.0 — Shipped</summary>',
|
|
'',
|
|
'### Phase 64: Auth Service',
|
|
'',
|
|
'</details>',
|
|
'',
|
|
].join('\n'),
|
|
);
|
|
|
|
// Active phasesDir: only phase 65
|
|
fs.mkdirSync(path.join(phasesDir, '65-current-work'), { recursive: true });
|
|
|
|
// Archive: milestones/v1.0-phases/64-auth-service
|
|
// MILESTONE_ARCHIVE_DIR_RE must match "v1.0-phases"
|
|
// PHASE_TOKEN_FROM_DIR_RE must extract "64" from "64-auth-service"
|
|
fs.mkdirSync(
|
|
path.join(planningDir, 'milestones', 'v1.0-phases', '64-auth-service'),
|
|
{ recursive: true },
|
|
);
|
|
});
|
|
|
|
after(() => { cleanup(tmpDir); });
|
|
|
|
test('no W006 for Phase 64 archived under milestones/v1.0-phases/', () => {
|
|
const result = runGsdTools(['validate', 'health', '--json'], tmpDir);
|
|
assert.strictEqual(result.success, true, `unexpected failure: ${result.error}`);
|
|
const data = JSON.parse(result.output);
|
|
const w006 = (data.warnings ?? []).filter(
|
|
(w) => w.code === 'W006' && /Phase 64/i.test(w.message),
|
|
);
|
|
assert.strictEqual(w006.length, 0,
|
|
`Expected no W006 for archived Phase 64, got: ${JSON.stringify(w006)}`);
|
|
});
|
|
|
|
test('MILESTONE_ARCHIVE_DIR_RE is exported and matches vN.N-phases dirs', () => {
|
|
const gen = require('../gsd-core/bin/lib/validate.cjs');
|
|
assert.ok(gen.MILESTONE_ARCHIVE_DIR_RE instanceof RegExp,
|
|
'validate.cjs must export MILESTONE_ARCHIVE_DIR_RE');
|
|
const re = gen.MILESTONE_ARCHIVE_DIR_RE;
|
|
assert.ok(re.test('v1.0-phases'), 'should match v1.0-phases');
|
|
assert.ok(re.test('v1.10-phases'), 'should match v1.10-phases');
|
|
assert.ok(!re.test('phases'), 'should NOT match plain phases');
|
|
assert.ok(!re.test('1.0-phases'), 'should NOT match missing v prefix');
|
|
});
|
|
|
|
test('PHASE_TOKEN_FROM_DIR_RE is exported and extracts phase tokens correctly', () => {
|
|
const gen = require('../gsd-core/bin/lib/validate.cjs');
|
|
assert.ok(gen.PHASE_TOKEN_FROM_DIR_RE instanceof RegExp,
|
|
'validate.cjs must export PHASE_TOKEN_FROM_DIR_RE');
|
|
const re = gen.PHASE_TOKEN_FROM_DIR_RE;
|
|
assert.strictEqual(re.exec('64-auth-service')?.[1], '64');
|
|
assert.strictEqual(re.exec('03B-feature')?.[1], '03B');
|
|
assert.strictEqual(re.exec('999.1-foo')?.[1], '999.1');
|
|
assert.strictEqual(re.exec('CK-64-auth')?.[1], '64');
|
|
});
|
|
});
|
|
|
|
// ── Drift Item I001: canonicalPlanStem ────────────────────────────────────────
|
|
//
|
|
// validate.ts Check 7: canonicalPlanStem('68-01-scaffolding') → '68-01'
|
|
// verify.cjs had an inline copy. After migration, canonicalPlanStem is
|
|
// sourced from validate.cjs.
|
|
//
|
|
// Test: "68-01-scaffolding-PLAN.md" + "68-01-SUMMARY.md" → no I001
|
|
// Both stems canonicalize to "68-01" → match found → I001 suppressed.
|
|
|
|
describe('Drift item I001 — canonicalPlanStem: long PLAN stem matches short SUMMARY stem', () => {
|
|
let tmpDir;
|
|
|
|
before(() => {
|
|
tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), 'gsd-26-d3-'));
|
|
const { planningDir, phasesDir } = mkplanning(tmpDir);
|
|
writeProjectMd(planningDir);
|
|
writeStateMd(planningDir, '68');
|
|
writeConfigJson(planningDir);
|
|
|
|
fs.writeFileSync(
|
|
path.join(planningDir, 'ROADMAP.md'),
|
|
'# Roadmap\n\n- [x] **Phase 68:** Scaffolding\n\n### Phase 68: Scaffolding\n',
|
|
);
|
|
|
|
const phaseDir = path.join(phasesDir, '68-scaffolding');
|
|
fs.mkdirSync(phaseDir, { recursive: true });
|
|
|
|
// Long-stem PLAN + short-stem SUMMARY → must match via canonicalPlanStem
|
|
fs.writeFileSync(path.join(phaseDir, '68-01-scaffolding-PLAN.md'), '---\nwave: 1\n---\n# Plan\n');
|
|
fs.writeFileSync(path.join(phaseDir, '68-01-SUMMARY.md'), '# Summary\n');
|
|
});
|
|
|
|
after(() => { cleanup(tmpDir); });
|
|
|
|
test('no I001 when 68-01-scaffolding-PLAN.md matches 68-01-SUMMARY.md via canonicalPlanStem', () => {
|
|
const result = runGsdTools(['validate', 'health', '--json'], tmpDir);
|
|
assert.strictEqual(result.success, true, `unexpected failure: ${result.error}`);
|
|
const data = JSON.parse(result.output);
|
|
const i001 = (data.info ?? []).filter((i) => i.code === 'I001');
|
|
assert.strictEqual(i001.length, 0,
|
|
`Expected zero I001, got: ${JSON.stringify(i001)}`);
|
|
});
|
|
|
|
test('canonicalPlanStem is exported from validate.cjs', () => {
|
|
const gen = require('../gsd-core/bin/lib/validate.cjs');
|
|
assert.strictEqual(typeof gen.canonicalPlanStem, 'function',
|
|
'validate.cjs must export canonicalPlanStem as a function');
|
|
assert.strictEqual(gen.canonicalPlanStem('68-01-scaffolding'), '68-01');
|
|
assert.strictEqual(gen.canonicalPlanStem('68-01'), '68-01');
|
|
assert.strictEqual(gen.canonicalPlanStem('3A-01-feature'), '3A-01');
|
|
assert.strictEqual(gen.canonicalPlanStem('no-match'), 'no-match');
|
|
});
|
|
});
|