ed8f4c9a31
Phase 3 of the CJS↔SDK hard-seam migration (parent #3524). Introduces the Builder/Reader pattern for paired Modules with mixed pure-and-I/O concerns — the template for Phase 4 and follow-up enhancements that migrate other paired Modules. Phase 1 and Phase 2 migrated Modules where both sides used character-equivalent logic. Phase 3 introduces the case where the pure logic is shareable but the I/O is legitimately per-side. The Builder/Reader split resolves this: - The Builder is pure — accepts pre-collected data (BuilderInputs struct), returns the typed projection. One source of truth; one generator-emitted CJS mirror. Drift is structurally impossible. - The Readers are per-side hand-authored Adapters that do the fs reads in their native idiom (currently both sync; either side can go async later without touching the Builder), then delegate to the Builder. - sdk/src/workstream-inventory/builder.ts — Builder source. 170 lines. Pure. Exports buildWorkstreamInventory(inputs), isCompletedInventory(status), plus the three typed inventory interfaces (WorkstreamPhaseInventory, WorkstreamInventory, WorkstreamInventoryList). - sdk/src/workstream-inventory/builder.test.ts — 18 vitest pinning fixtures across all status branches, progress-percent clamping, active-marker projection, and isCompletedInventory classifier. - sdk/scripts/gen-workstream-inventory-builder.mjs — generator. Captures function bodies via Function.prototype.toString(); emits with the standard GENERATED FILE banner. Includes a small `const relative = path.relative;` preamble in the output to handle ESM destructured imports in the compiled source. - sdk/scripts/check-workstream-inventory-builder-fresh.mjs — freshness check. Imports the generator function directly (rather than duplicating logic) — a cleaner pattern than Phase 1/2's approach. - get-shit-done/bin/lib/workstream-inventory-builder.generated.cjs — generator-emitted CJS mirror. - tests/workstream-inventory-builder-generator.test.cjs — 16 parity assertions confirming CJS-generated output == SDK source output for every fixture. - bin/lib/workstream-inventory.cjs: 159 → 132 lines. Projection logic gone. `inspectWorkstream` and `listWorkstreamInventories` collect BuilderInputs via the existing sync fs functions and delegate to the Builder. `isCompletedInventory` re-exported from the Builder (its signature changed from object→string, but no external callers exist so the change is safe). - sdk/src/query/workstream-inventory.ts: 196 → 143 lines. Same shape, sync fs (the SDK was already sync — surprise from recon). Types re-exported from the Builder. - sdk/package.json: gen:workstream-inventory-builder and check:workstream-inventory-builder-fresh scripts. - package.json: proxy for the freshness check. - .githooks/pre-commit: drift block. - .github/workflows/test.yml: drift check step. - CONTEXT.md: amended "Workstream Inventory Module" entry to document the Builder/Reader split. - docs/INVENTORY.md, docs/INVENTORY-MANIFEST.json: +1 module count, +1 row for the generated builder. - Full suite: 9229/9229 pass (baseline 9215 + 14 net new from the parity assertions). - Vitest: 18 Builder fixtures pass. - Reader shrink: -27 lines on CJS, -53 lines on SDK. - Net diff (modified files only): +68 / -133 = 65-line reduction. New files (Builder, generator, freshness check, parity test) add ~600 lines of new structured code. 1. `isCompletedInventory` signature changed from isCompletedInventory(inventory: object) to isCompletedInventory(status: string). Original CJS exported the object form but no external caller passed an object — they all passed inventory.status. Verified by grep before committing. 2. Generator preamble. The compiled ESM uses `import { relative } from 'node:path'`, making `relative` a free variable in `buildWorkstreamInventory`. The generator emits `const relative = path.relative;` so the captured function body works in CJS. 3. Freshness check imports the generator. The freshness check imports the generator's buildWorkstreamInventoryBuilderCjs() function directly rather than duplicating generation logic. Cleaner than Phase 1/2; future generators should follow this. Shareable via the Builder/Reader pattern in future enhancements: - frontmatter (pure YAML/markdown parsing) - plan-scan (pure PLAN.md structure parsing) - decisions (pure decision-record parsing) - secrets (regex-based detection in text) - uat (UAT-criteria parsing) Structural divergence — different approach needed: - state — sync vs async file ops; mutation paths differ. - workstream — lifecycle ops; per-side API surface differs. - phase, roadmap, init, profile-output, template — large surfaces; each its own potential enhancement. None of these is in scope for Phase 3. Closes #3544.
80 lines
2.7 KiB
JavaScript
80 lines
2.7 KiB
JavaScript
'use strict';
|
|
|
|
/**
|
|
* GENERATED FILE — DO NOT EDIT.
|
|
*
|
|
* Source: sdk/src/workstream-inventory/builder.ts
|
|
* Regenerate: cd sdk && npm run gen:workstream-inventory-builder
|
|
*
|
|
* Workstream Inventory Builder — pure projection from pre-collected
|
|
* filesystem data to typed WorkstreamInventory. No I/O. No async.
|
|
*/
|
|
|
|
const path = require('path');
|
|
const relative = path.relative;
|
|
|
|
// Internal helpers
|
|
function toPosixPath(p) {
|
|
return p.split('\\').join('/');
|
|
}
|
|
|
|
function isCompletedInventory(status) {
|
|
const s = String(status ?? '').toLowerCase();
|
|
return s.includes('milestone complete') || s.includes('archived');
|
|
}
|
|
|
|
function buildWorkstreamInventory(inputs) {
|
|
const { name, projectDir, workstreamDir, phaseDirNames, activeWorkstreamName, phaseFilesCounts, roadmapPhaseCount, stateProjection, filesExist, } = inputs;
|
|
// Index counts by directory for O(1) lookup during sort/iteration
|
|
const countsMap = new Map();
|
|
for (const entry of phaseFilesCounts) {
|
|
countsMap.set(entry.directory, { planCount: entry.planCount, summaryCount: entry.summaryCount });
|
|
}
|
|
const phases = [];
|
|
let completedPhases = 0;
|
|
let totalPlans = 0;
|
|
let completedPlans = 0;
|
|
for (const dir of [...phaseDirNames].sort()) {
|
|
const counts = countsMap.get(dir) ?? { planCount: 0, summaryCount: 0 };
|
|
const status = counts.summaryCount >= counts.planCount && counts.planCount > 0
|
|
? 'complete'
|
|
: counts.planCount > 0
|
|
? 'in_progress'
|
|
: 'pending';
|
|
totalPlans += counts.planCount;
|
|
completedPlans += Math.min(counts.summaryCount, counts.planCount);
|
|
if (status === 'complete')
|
|
completedPhases++;
|
|
phases.push({
|
|
directory: dir,
|
|
status,
|
|
plan_count: counts.planCount,
|
|
summary_count: counts.summaryCount,
|
|
});
|
|
}
|
|
return {
|
|
name,
|
|
path: toPosixPath(relative(projectDir, workstreamDir)),
|
|
active: name === activeWorkstreamName,
|
|
files: {
|
|
roadmap: filesExist.roadmap,
|
|
state: filesExist.state,
|
|
requirements: filesExist.requirements,
|
|
},
|
|
status: stateProjection.status,
|
|
current_phase: stateProjection.current_phase,
|
|
last_activity: stateProjection.last_activity,
|
|
phases,
|
|
phase_count: phases.length,
|
|
completed_phases: completedPhases,
|
|
roadmap_phase_count: roadmapPhaseCount,
|
|
total_plans: totalPlans,
|
|
completed_plans: completedPlans,
|
|
progress_percent: roadmapPhaseCount > 0
|
|
? Math.min(100, Math.round((completedPhases / roadmapPhaseCount) * 100))
|
|
: 0,
|
|
};
|
|
}
|
|
|
|
module.exports = { buildWorkstreamInventory, isCompletedInventory };
|