fix(2137): skip worktree isolation when .gitmodules detected (#2144)
* feat(sdk): add typed query foundation and gsd-sdk query (Phase 1) Add sdk/src/query registry and handlers with tests, GSDQueryError, CLI query wiring, and supporting type/tool-scoping hooks. Update CHANGELOG. Vitest 4 constructor mock fixes in milestone-runner tests. Made-with: Cursor * fix(2137): skip worktree isolation when .gitmodules detected When a project contains git submodules, worktree isolation cannot correctly handle submodule commits — three separate gaps exist in worktree setup, executor commit protocol, and merge-back. Rather than patch each gap individually, detect .gitmodules at phase start and fall back to sequential execution, which handles submodules transparently (Option B). Affected workflows: execute-phase.md, quick.md --------- Co-authored-by: David Sienkowski <dave@sienkowski.com>
This commit is contained in:
Tom Boucher
252
sdk/src/query/workstream.ts
Normal file
252
sdk/src/query/workstream.ts
Normal file
@@ -0,0 +1,252 @@
|
||||
/**
|
||||
* Workstream query handlers — list, create, set, status, complete, progress.
|
||||
*
|
||||
* Ported from get-shit-done/bin/lib/workstream.cjs.
|
||||
* Manages .planning/workstreams/ directory for multi-workstream projects.
|
||||
*
|
||||
* @example
|
||||
* ```typescript
|
||||
* import { workstreamList, workstreamCreate } from './workstream.js';
|
||||
*
|
||||
* await workstreamList([], '/project');
|
||||
* // { data: { workstreams: ['backend', 'frontend'], count: 2 } }
|
||||
*
|
||||
* await workstreamCreate(['api'], '/project');
|
||||
* // { data: { created: true, name: 'api', path: '.planning/workstreams/api' } }
|
||||
* ```
|
||||
*/
|
||||
|
||||
import {
|
||||
existsSync, readdirSync, readFileSync, writeFileSync,
|
||||
mkdirSync, renameSync, rmdirSync, unlinkSync,
|
||||
} from 'node:fs';
|
||||
import { mkdir } from 'node:fs/promises';
|
||||
import { join, relative } from 'node:path';
|
||||
|
||||
import { toPosixPath } from './helpers.js';
|
||||
import type { QueryHandler } from './utils.js';
|
||||
|
||||
// ─── Internal helpers ─────────────────────────────────────────────────────
|
||||
|
||||
const planningRoot = (projectDir: string) =>
|
||||
join(projectDir, '.planning');
|
||||
|
||||
const workstreamsDir = (projectDir: string) =>
|
||||
join(planningRoot(projectDir), 'workstreams');
|
||||
|
||||
function getActiveWorkstream(projectDir: string): string | null {
|
||||
const filePath = join(planningRoot(projectDir), 'active-workstream');
|
||||
try {
|
||||
const name = readFileSync(filePath, 'utf-8').trim();
|
||||
if (!name || !/^[a-zA-Z0-9_-]+$/.test(name)) {
|
||||
try { unlinkSync(filePath); } catch { /* already gone */ }
|
||||
return null;
|
||||
}
|
||||
const wsDir = join(workstreamsDir(projectDir), name);
|
||||
if (!existsSync(wsDir)) {
|
||||
try { unlinkSync(filePath); } catch { /* already gone */ }
|
||||
return null;
|
||||
}
|
||||
return name;
|
||||
} catch {
|
||||
return null;
|
||||
}
|
||||
}
|
||||
|
||||
function setActiveWorkstream(projectDir: string, name: string | null): void {
|
||||
const filePath = join(planningRoot(projectDir), 'active-workstream');
|
||||
if (!name) {
|
||||
try { unlinkSync(filePath); } catch { /* already gone */ }
|
||||
return;
|
||||
}
|
||||
if (!/^[a-zA-Z0-9_-]+$/.test(name)) {
|
||||
throw new Error('Invalid workstream name: must be alphanumeric, hyphens, and underscores only');
|
||||
}
|
||||
writeFileSync(filePath, name + '\n', 'utf-8');
|
||||
}
|
||||
|
||||
// ─── Handlers ─────────────────────────────────────────────────────────────
|
||||
|
||||
export const workstreamList: QueryHandler = async (_args, projectDir) => {
|
||||
const dir = workstreamsDir(projectDir);
|
||||
if (!existsSync(dir)) return { data: { mode: 'flat', workstreams: [], message: 'No workstreams — operating in flat mode' } };
|
||||
try {
|
||||
const entries = readdirSync(dir, { withFileTypes: true }) as unknown as Array<{ isDirectory(): boolean; name: string }>;
|
||||
const workstreams = entries.filter(e => e.isDirectory()).map(e => e.name);
|
||||
return { data: { mode: 'workstream', workstreams, count: workstreams.length } };
|
||||
} catch {
|
||||
return { data: { mode: 'flat', workstreams: [], count: 0 } };
|
||||
}
|
||||
};
|
||||
|
||||
export const workstreamCreate: QueryHandler = async (args, projectDir) => {
|
||||
const rawName = args[0];
|
||||
if (!rawName) return { data: { created: false, reason: 'name required' } };
|
||||
if (rawName.includes('/') || rawName.includes('\\') || rawName.includes('..')) {
|
||||
return { data: { created: false, reason: 'invalid workstream name — path separators not allowed' } };
|
||||
}
|
||||
|
||||
const slug = rawName.toLowerCase().replace(/[^a-z0-9]+/g, '-').replace(/^-+|-+$/g, '');
|
||||
if (!slug) return { data: { created: false, reason: 'invalid workstream name — must contain at least one alphanumeric character' } };
|
||||
|
||||
const baseDir = planningRoot(projectDir);
|
||||
if (!existsSync(baseDir)) {
|
||||
return { data: { created: false, reason: '.planning/ directory not found — run /gsd-new-project first' } };
|
||||
}
|
||||
|
||||
const wsRoot = workstreamsDir(projectDir);
|
||||
const wsDir = join(wsRoot, slug);
|
||||
|
||||
if (existsSync(wsDir) && existsSync(join(wsDir, 'STATE.md'))) {
|
||||
return { data: { created: false, error: 'already_exists', workstream: slug, path: toPosixPath(relative(projectDir, wsDir)) } };
|
||||
}
|
||||
|
||||
mkdirSync(wsDir, { recursive: true });
|
||||
mkdirSync(join(wsDir, 'phases'), { recursive: true });
|
||||
|
||||
const today = new Date().toISOString().split('T')[0];
|
||||
const stateContent = [
|
||||
'---',
|
||||
`workstream: ${slug}`,
|
||||
`created: ${today}`,
|
||||
'---',
|
||||
'',
|
||||
'# Project State',
|
||||
'',
|
||||
'## Current Position',
|
||||
'**Status:** Not started',
|
||||
'**Current Phase:** None',
|
||||
`**Last Activity:** ${today}`,
|
||||
'**Last Activity Description:** Workstream created',
|
||||
'',
|
||||
'## Progress',
|
||||
'**Phases Complete:** 0',
|
||||
'**Current Plan:** N/A',
|
||||
'',
|
||||
'## Session Continuity',
|
||||
'**Stopped At:** N/A',
|
||||
'**Resume File:** None',
|
||||
'',
|
||||
].join('\n');
|
||||
|
||||
const statePath = join(wsDir, 'STATE.md');
|
||||
if (!existsSync(statePath)) {
|
||||
writeFileSync(statePath, stateContent, 'utf-8');
|
||||
}
|
||||
|
||||
setActiveWorkstream(projectDir, slug);
|
||||
|
||||
const relPath = toPosixPath(relative(projectDir, wsDir));
|
||||
return {
|
||||
data: {
|
||||
created: true,
|
||||
workstream: slug,
|
||||
path: relPath,
|
||||
state_path: relPath + '/STATE.md',
|
||||
phases_path: relPath + '/phases',
|
||||
active: true,
|
||||
},
|
||||
};
|
||||
};
|
||||
|
||||
export const workstreamSet: QueryHandler = async (args, projectDir) => {
|
||||
const name = args[0];
|
||||
|
||||
if (!name || name === '--clear') {
|
||||
if (name !== '--clear') {
|
||||
return { data: { set: false, reason: 'name required. Usage: workstream set <name> (or workstream set --clear to unset)' } };
|
||||
}
|
||||
const previous = getActiveWorkstream(projectDir);
|
||||
setActiveWorkstream(projectDir, null);
|
||||
return { data: { active: null, cleared: true, previous: previous || null } };
|
||||
}
|
||||
|
||||
if (!/^[a-zA-Z0-9_-]+$/.test(name)) {
|
||||
return { data: { active: null, error: 'invalid_name', message: 'Workstream name must be alphanumeric, hyphens, and underscores only' } };
|
||||
}
|
||||
|
||||
const wsDir = join(workstreamsDir(projectDir), name);
|
||||
if (!existsSync(wsDir)) {
|
||||
return { data: { active: null, error: 'not_found', workstream: name } };
|
||||
}
|
||||
|
||||
const previous = getActiveWorkstream(projectDir);
|
||||
setActiveWorkstream(projectDir, name);
|
||||
return { data: { active: name, previous: previous || null, set: true } };
|
||||
};
|
||||
|
||||
export const workstreamStatus: QueryHandler = async (args, projectDir) => {
|
||||
const name = args[0];
|
||||
if (!name) return { data: { found: false, reason: 'name required' } };
|
||||
const wsDir = join(workstreamsDir(projectDir), name);
|
||||
return { data: { name, found: existsSync(wsDir), path: toPosixPath(relative(projectDir, wsDir)) } };
|
||||
};
|
||||
|
||||
export const workstreamComplete: QueryHandler = async (args, projectDir) => {
|
||||
const name = args[0];
|
||||
if (!name) return { data: { completed: false, reason: 'workstream name required' } };
|
||||
if (/[/\\]/.test(name) || name === '.' || name === '..') {
|
||||
return { data: { completed: false, reason: 'invalid workstream name' } };
|
||||
}
|
||||
|
||||
const root = planningRoot(projectDir);
|
||||
const wsRoot = workstreamsDir(projectDir);
|
||||
const wsDir = join(wsRoot, name);
|
||||
|
||||
if (!existsSync(wsDir)) {
|
||||
return { data: { completed: false, error: 'not_found', workstream: name } };
|
||||
}
|
||||
|
||||
const active = getActiveWorkstream(projectDir);
|
||||
if (active === name) setActiveWorkstream(projectDir, null);
|
||||
|
||||
const archiveDir = join(root, 'milestones');
|
||||
const today = new Date().toISOString().split('T')[0];
|
||||
let archivePath = join(archiveDir, `ws-${name}-${today}`);
|
||||
let suffix = 1;
|
||||
while (existsSync(archivePath)) {
|
||||
archivePath = join(archiveDir, `ws-${name}-${today}-${suffix++}`);
|
||||
}
|
||||
|
||||
mkdirSync(archivePath, { recursive: true });
|
||||
|
||||
const filesMoved: string[] = [];
|
||||
try {
|
||||
const entries = readdirSync(wsDir, { withFileTypes: true }) as unknown as Array<{ isDirectory(): boolean; name: string }>;
|
||||
for (const entry of entries) {
|
||||
renameSync(join(wsDir, entry.name), join(archivePath, entry.name));
|
||||
filesMoved.push(entry.name);
|
||||
}
|
||||
} catch (err) {
|
||||
for (const fname of filesMoved) {
|
||||
try { renameSync(join(archivePath, fname), join(wsDir, fname)); } catch { /* rollback */ }
|
||||
}
|
||||
try { rmdirSync(archivePath); } catch { /* cleanup */ }
|
||||
if (active === name) setActiveWorkstream(projectDir, name);
|
||||
return { data: { completed: false, error: 'archive_failed', message: String(err), workstream: name } };
|
||||
}
|
||||
|
||||
try { rmdirSync(wsDir); } catch { /* may not be empty */ }
|
||||
|
||||
let remainingWs = 0;
|
||||
try {
|
||||
remainingWs = (readdirSync(wsRoot, { withFileTypes: true }) as unknown as Array<{ isDirectory(): boolean; name: string }>)
|
||||
.filter(e => e.isDirectory()).length;
|
||||
if (remainingWs === 0) rmdirSync(wsRoot);
|
||||
} catch { /* best-effort */ }
|
||||
|
||||
return {
|
||||
data: {
|
||||
completed: true,
|
||||
workstream: name,
|
||||
archived_to: toPosixPath(relative(projectDir, archivePath)),
|
||||
remaining_workstreams: remainingWs,
|
||||
reverted_to_flat: remainingWs === 0,
|
||||
},
|
||||
};
|
||||
};
|
||||
|
||||
export const workstreamProgress: QueryHandler = async (args, projectDir) => {
|
||||
const { progressBar } = await import('./progress.js');
|
||||
return progressBar(args, projectDir);
|
||||
};
|
||||
Reference in New Issue
Block a user