* feat(sdk): golden parity harness and query handler CJS alignment (#2302 Track A) Golden/read-only parity tests and registry alignment, query handler fixes (check-completion, state-mutation, commit, validate, summary, etc.), and WAITING.json dual-write for .gsd/.planning readers. Refs gsd-build/get-shit-done#2341 * fix(sdk): getMilestoneInfo matches GSD ROADMAP (🟡, last bold, STATE fallback) - Recognize in-flight 🟡 milestone bullets like 🚧. - Derive from last **vX.Y Title** before ## Phases when emoji absent. - Fall back to STATE.md milestone when ROADMAP is missing; use last bare vX.Y in cleaned text instead of first (avoids v1.0 from shipped list). - Fixes init.execute-phase milestone_version and buildStateFrontmatter after state.begin-phase (syncStateFrontmatter). * feat(sdk): phase list, plan task structure, requirements extract handlers - Register phase.list-plans, phase.list-artifacts, plan.task-structure, requirements.extract-from-plans (SDK-only; golden-policy exceptions). - Add unit tests; document in QUERY-HANDLERS.md. - writeProfile: honor --output, render dimensions, return profile_path and dimensions_scored. * feat(sdk): centralize getGsdAgentsDir in query helpers Extract agent directory resolution to helpers (GSD_AGENTS_DIR, primary ~/.claude/agents, legacy path). Use from init and docs-init init bundles. docs(15): add 15-CONTEXT for autonomous phase-15 run. * feat(sdk): query CLI CJS fallback and session correlation - createRegistry(eventStream, sessionId) threads correlation into mutation events - gsd-sdk query falls back to gsd-tools.cjs when no native handler matches (disable with GSD_QUERY_FALLBACK=off); stderr bridge warnings - Export createRegistry from @gsd-build/sdk; add sdk/README.md - Update QUERY-HANDLERS.md and registry module docs for fallback + sessionId - Agents: prefer node dist/cli.js query over cat/grep for STATE and plans * fix(sdk): init phase_found parity, docs-init agents path, state field extract - Normalize findPhase not-found to null before roadmap fallback (matches findPhaseInternal) - docs-init: use detectRuntime + resolveAgentsDir for checkAgentsInstalled - state.cjs stateExtractField: horizontal whitespace only after colon (YAML progress guard) - Tests: commit_docs default true; config-get golden uses temp config; golden integration green Refs: #2302 * refactor(sdk): share SessionJsonlRecord in profile-extract-messages CodeRabbit nit: dedupe JSONL record shape for isGenuineUserMessage and streamExtractMessages. * fix(sdk): address CodeRabbit major threads (paths, gates, audit, verify) - Resolve @file: and CLI JSON indirection relative to projectDir; guard empty normalized query command - plan.task-structure + intel extract/patch-meta: resolvePathUnderProject containment - check.config-gates: safe string booleans; plan_checker alias precedence over plan_check default - state.validate/sync: phaseTokenMatches + comparePhaseNum ordering - verify.schema-drift: token match phase dirs; files_modified from parsed frontmatter - audit-open: has_scan_errors, unreadable rows, human report when scans fail - requirements PLANNED key PLAN for root PLAN.md; gsd-tools timeout note - ingest-docs: repo-root path containment; classifier output slug-hash Golden parity test strips has_scan_errors until CJS adds field. * fix: Resolve CodeRabbit security and quality findings - Secure intel.ts and cli.ts against path traversal - Catch and validate git add status in commit.ts - Expand roadmap milestone marker extraction - Fix parsing array-of-objects in frontmatter YAML - Fix unhandled config evaluations - Improve coverage test parity mapping * test: raise planner character extraction limit to 48K * fix(sdk): resolve TS build error in docs-init passing config
This commit is contained in:
Rezolv
152
sdk/src/query/phase-list-queries.ts
Normal file
152
sdk/src/query/phase-list-queries.ts
Normal file
@@ -0,0 +1,152 @@
|
||||
/**
|
||||
* Handlers: phase.list-plans, phase.list-artifacts — deterministic plan/artifact listing
|
||||
* for agents (replaces shell `ls` / `find` patterns). SDK-only; no gsd-tools.cjs mirror.
|
||||
*/
|
||||
|
||||
import { readFile, readdir } from 'node:fs/promises';
|
||||
import { join, relative } from 'node:path';
|
||||
import { GSDError, ErrorClassification } from '../errors.js';
|
||||
import { extractFrontmatter } from './frontmatter.js';
|
||||
import {
|
||||
normalizePhaseName,
|
||||
comparePhaseNum,
|
||||
phaseTokenMatches,
|
||||
toPosixPath,
|
||||
planningPaths,
|
||||
} from './helpers.js';
|
||||
import type { QueryHandler } from './utils.js';
|
||||
|
||||
/** Resolve `.planning/phases/<dir>` for a phase token, or null. */
|
||||
async function resolvePhaseDir(phase: string, projectDir: string): Promise<string | null> {
|
||||
const phasesDir = planningPaths(projectDir).phases;
|
||||
const normalized = normalizePhaseName(phase);
|
||||
try {
|
||||
const entries = await readdir(phasesDir, { withFileTypes: true });
|
||||
const dirs = entries
|
||||
.filter(e => e.isDirectory())
|
||||
.map(e => e.name)
|
||||
.sort((a, b) => comparePhaseNum(a, b));
|
||||
const match = dirs.find(d => phaseTokenMatches(d, normalized));
|
||||
return match ? join(phasesDir, match) : null;
|
||||
} catch {
|
||||
return null;
|
||||
}
|
||||
}
|
||||
|
||||
type ArtifactType = 'context' | 'summary' | 'verification' | 'research';
|
||||
|
||||
/**
|
||||
* phase.list-artifacts — list CONTEXT / SUMMARY / VERIFICATION / RESEARCH files in a phase directory.
|
||||
*
|
||||
* Args: `<phase>` `--type` `<context|summary|verification|research>`
|
||||
*/
|
||||
export const phaseListArtifacts: QueryHandler = async (args, projectDir) => {
|
||||
if (!args[0]) {
|
||||
throw new GSDError('phase required', ErrorClassification.Validation);
|
||||
}
|
||||
const typeIdx = args.indexOf('--type');
|
||||
if (typeIdx === -1 || !args[typeIdx + 1]) {
|
||||
throw new GSDError('--type context|summary|verification|research required', ErrorClassification.Validation);
|
||||
}
|
||||
const phase = args[0];
|
||||
const rawType = args[typeIdx + 1].toLowerCase();
|
||||
const allowed: ArtifactType[] = ['context', 'summary', 'verification', 'research'];
|
||||
if (!allowed.includes(rawType as ArtifactType)) {
|
||||
throw new GSDError(`invalid --type ${rawType}`, ErrorClassification.Validation);
|
||||
}
|
||||
const artifactType = rawType as ArtifactType;
|
||||
|
||||
const phaseDir = await resolvePhaseDir(phase, projectDir);
|
||||
if (!phaseDir) {
|
||||
return { data: { phase: normalizePhaseName(phase), type: artifactType, artifacts: [], error: 'Phase not found' } };
|
||||
}
|
||||
|
||||
const files = await readdir(phaseDir);
|
||||
const baseNames = files.filter((f) => {
|
||||
if (artifactType === 'context') {
|
||||
return f.endsWith('-CONTEXT.md') || f === 'CONTEXT.md';
|
||||
}
|
||||
if (artifactType === 'summary') {
|
||||
return f.endsWith('-SUMMARY.md') || f === 'SUMMARY.md';
|
||||
}
|
||||
if (artifactType === 'verification') {
|
||||
return f.endsWith('-VERIFICATION.md') || f === 'VERIFICATION.md';
|
||||
}
|
||||
return f.endsWith('-RESEARCH.md') || f === 'RESEARCH.md';
|
||||
});
|
||||
|
||||
const artifacts = baseNames.sort().map((f) =>
|
||||
toPosixPath(relative(projectDir, join(phaseDir, f))),
|
||||
);
|
||||
|
||||
return {
|
||||
data: {
|
||||
phase: normalizePhaseName(phase),
|
||||
type: artifactType,
|
||||
artifacts,
|
||||
},
|
||||
};
|
||||
};
|
||||
|
||||
/**
|
||||
* phase.list-plans — list PLAN files in a phase with optional frontmatter key filter.
|
||||
*
|
||||
* Args: `<phase>` [`--with-schema` `<yamlKey>`]
|
||||
*/
|
||||
export const phaseListPlans: QueryHandler = async (args, projectDir) => {
|
||||
if (!args[0]) {
|
||||
throw new GSDError('phase required', ErrorClassification.Validation);
|
||||
}
|
||||
let schemaKey: string | null = null;
|
||||
const wsIdx = args.indexOf('--with-schema');
|
||||
if (wsIdx !== -1) {
|
||||
schemaKey = args[wsIdx + 1] ?? null;
|
||||
if (!schemaKey) {
|
||||
throw new GSDError('--with-schema requires a field name', ErrorClassification.Validation);
|
||||
}
|
||||
}
|
||||
|
||||
const phase = args[0];
|
||||
const normalized = normalizePhaseName(phase);
|
||||
const phaseDir = await resolvePhaseDir(phase, projectDir);
|
||||
if (!phaseDir) {
|
||||
return {
|
||||
data: {
|
||||
phase: normalized,
|
||||
plans: [] as Array<Record<string, unknown>>,
|
||||
error: 'Phase not found',
|
||||
},
|
||||
};
|
||||
}
|
||||
|
||||
const phaseFiles = await readdir(phaseDir);
|
||||
const planFiles = phaseFiles.filter(f => f.endsWith('-PLAN.md') || f === 'PLAN.md').sort();
|
||||
|
||||
const plans: Array<Record<string, unknown>> = [];
|
||||
for (const planFile of planFiles) {
|
||||
const planId = planFile.replace('-PLAN.md', '').replace('PLAN.md', '');
|
||||
const planPath = join(phaseDir, planFile);
|
||||
const content = await readFile(planPath, 'utf-8');
|
||||
const fm = extractFrontmatter(content) as Record<string, unknown>;
|
||||
|
||||
if (schemaKey && !(schemaKey in fm)) {
|
||||
continue;
|
||||
}
|
||||
|
||||
plans.push({
|
||||
id: planId,
|
||||
file: toPosixPath(planFile),
|
||||
wave: parseInt(String(fm.wave ?? '1'), 10) || 1,
|
||||
autonomous: fm.autonomous !== false && fm.autonomous !== 'false',
|
||||
frontmatter_keys: Object.keys(fm).sort(),
|
||||
});
|
||||
}
|
||||
|
||||
return {
|
||||
data: {
|
||||
phase: normalized,
|
||||
with_schema: schemaKey,
|
||||
plans,
|
||||
},
|
||||
};
|
||||
};
|
||||
Reference in New Issue
Block a user