fix: scan bin/lib subdirectories in the inventory-manifest generator
gen-inventory-manifest.cjs's cli_modules family did a flat readdirSync of gsd-core/bin/lib/, invisible to anything shipped in a subdirectory. Found while registering this phase's 8 health-diagnostic-rules/*.cjs files in docs/INVENTORY.md (Standards-axis review) — the automated manifest cross-check couldn't see them even though the manual INVENTORY.md rows were correct. Adds collectOneLevelSubdirs (mirrors the existing collectNested's defensive statOrNull style) and merges flat + one-level-subdirectory results into cli_modules's single sorted array, using the same <subdir>/<file>.cjs key format INVENTORY.md's rows already use. Regenerating the manifest surfaced that three OTHER existing subdirectories (installer-migrations/, host-integration-adapters/, observability/ — pre-existing, unrelated to this phase) were equally invisible and had zero docs/INVENTORY.md rows at all. Added all 15 missing rows rather than leave a gap the fix itself just exposed. Also fixes 3 pre-existing lint-legacy-dir-name violations in the installer-migrations rows (legitimate references to the historical get-shit-done -> gsd-core rename these migrations clean up — marked with the guard's own gsd-allow-legacy-name exemption) and a stale health-diagnostic.cjs row that still said "RULES ships empty."
This commit is contained in:
@@ -20,7 +20,7 @@ const MANIFEST_PATH = path.join(ROOT, 'docs', 'INVENTORY-MANIFEST.json');
|
||||
// a family added to the generator but not here left this test silently verifying a
|
||||
// subset while still reporting green. Importing makes divergence impossible rather than
|
||||
// merely detectable.
|
||||
const { FAMILIES, NESTED_FAMILIES, collectNested } = require('../scripts/gen-inventory-manifest.cjs');
|
||||
const { FAMILIES, NESTED_FAMILIES, collectNested, collectOneLevelSubdirs } = require('../scripts/gen-inventory-manifest.cjs');
|
||||
|
||||
test('docs/INVENTORY-MANIFEST.json matches the filesystem', () => {
|
||||
const committed = JSON.parse(fs.readFileSync(MANIFEST_PATH, 'utf8'));
|
||||
@@ -28,11 +28,14 @@ test('docs/INVENTORY-MANIFEST.json matches the filesystem', () => {
|
||||
const removals = [];
|
||||
|
||||
for (const { name, dir, filter, toName } of FAMILIES) {
|
||||
const live = new Set(
|
||||
fs.readdirSync(dir)
|
||||
.filter((f) => fs.statSync(path.join(dir, f)).isFile() && filter(f))
|
||||
.map(toName),
|
||||
);
|
||||
const flat = fs.readdirSync(dir)
|
||||
.filter((f) => fs.statSync(path.join(dir, f)).isFile() && filter(f))
|
||||
.map(toName);
|
||||
// `cli_modules` also ships one level of subdirectory modules (#3309); mirror
|
||||
// buildManifest's special-case merge exactly, or this test would report every
|
||||
// subdirectory file as a phantom removal.
|
||||
const nested = name === 'cli_modules' ? collectOneLevelSubdirs({ dir, filter }) : [];
|
||||
const live = new Set([...flat, ...nested]);
|
||||
const recorded = new Set((committed.families || {})[name] || []);
|
||||
|
||||
for (const entry of live) {
|
||||
|
||||
@@ -18,10 +18,11 @@ const fs = require('node:fs');
|
||||
const os = require('node:os');
|
||||
const path = require('node:path');
|
||||
|
||||
const { collectNested } = require('../scripts/gen-inventory-manifest.cjs');
|
||||
const { collectNested, collectOneLevelSubdirs } = require('../scripts/gen-inventory-manifest.cjs');
|
||||
const { cleanup } = require('./helpers.cjs');
|
||||
|
||||
const MD_ONLY = (f) => f.endsWith('.md');
|
||||
const CJS_ONLY = (f) => f.endsWith('.cjs');
|
||||
|
||||
/** Build a fixture tree: {parentName: {subdirName: [fileNames]}}. */
|
||||
function buildTree(spec) {
|
||||
@@ -174,3 +175,104 @@ test('collectNested is deterministic and sorted', (t) => {
|
||||
assert.deepStrictEqual(first, second);
|
||||
assert.deepStrictEqual(first, ['alpha/steps/c.md', 'zeta/steps/a.md', 'zeta/steps/b.md']);
|
||||
});
|
||||
|
||||
// ─── collectOneLevelSubdirs — cli_modules one-level subdir scan (#3309) ───────
|
||||
//
|
||||
// Unlike collectNested's FIXED subdir name (many parents, one shared child-dir
|
||||
// name like `steps`), this helper's `dir` IS the parent, and every one of ITS
|
||||
// child directories is the thing being collected — e.g. `bin/lib/health-diagnostic-rules/`.
|
||||
|
||||
/** Build a fixture tree directly under `dir`: {subdirName: [fileNames]} \| flat file list. */
|
||||
function buildSubdirTree(dir, spec) {
|
||||
for (const [subdir, files] of Object.entries(spec)) {
|
||||
const subdirPath = path.join(dir, subdir);
|
||||
fs.mkdirSync(subdirPath, { recursive: true });
|
||||
for (const f of files) fs.writeFileSync(path.join(subdirPath, f), '// fixture\n');
|
||||
}
|
||||
}
|
||||
|
||||
test('collectOneLevelSubdirs picks up a file inside a subdirectory', (t) => {
|
||||
const dir = fs.mkdtempSync(path.join(os.tmpdir(), 'gsd-3309-onelevel-'));
|
||||
t.after(() => cleanup(dir));
|
||||
buildSubdirTree(dir, { 'health-diagnostic-rules': ['root-existence.cjs'] });
|
||||
|
||||
assert.deepStrictEqual(
|
||||
collectOneLevelSubdirs({ dir, filter: CJS_ONLY }),
|
||||
['health-diagnostic-rules/root-existence.cjs'],
|
||||
);
|
||||
});
|
||||
|
||||
test('collectOneLevelSubdirs merges multiple subdirectories, sorted', (t) => {
|
||||
const dir = fs.mkdtempSync(path.join(os.tmpdir(), 'gsd-3309-onelevel-'));
|
||||
t.after(() => cleanup(dir));
|
||||
buildSubdirTree(dir, {
|
||||
observability: ['redaction.cjs', 'event.cjs'],
|
||||
'installer-migrations': ['001-x.cjs'],
|
||||
});
|
||||
|
||||
assert.deepStrictEqual(
|
||||
collectOneLevelSubdirs({ dir, filter: CJS_ONLY }),
|
||||
['installer-migrations/001-x.cjs', 'observability/event.cjs', 'observability/redaction.cjs'],
|
||||
);
|
||||
});
|
||||
|
||||
test('collectOneLevelSubdirs contributes nothing for an empty subdirectory', (t) => {
|
||||
const dir = fs.mkdtempSync(path.join(os.tmpdir(), 'gsd-3309-onelevel-'));
|
||||
t.after(() => cleanup(dir));
|
||||
fs.mkdirSync(path.join(dir, 'empty-subdir'), { recursive: true });
|
||||
|
||||
assert.deepStrictEqual(collectOneLevelSubdirs({ dir, filter: CJS_ONLY }), []);
|
||||
});
|
||||
|
||||
test('collectOneLevelSubdirs ignores files directly in dir (flat scan owns those)', (t) => {
|
||||
const dir = fs.mkdtempSync(path.join(os.tmpdir(), 'gsd-3309-onelevel-'));
|
||||
t.after(() => cleanup(dir));
|
||||
fs.writeFileSync(path.join(dir, 'top-level.cjs'), '// fixture\n');
|
||||
buildSubdirTree(dir, { subdir: ['nested.cjs'] });
|
||||
|
||||
assert.deepStrictEqual(collectOneLevelSubdirs({ dir, filter: CJS_ONLY }), ['subdir/nested.cjs']);
|
||||
});
|
||||
|
||||
test('collectOneLevelSubdirs applies the filter and ignores non-matching files', (t) => {
|
||||
const dir = fs.mkdtempSync(path.join(os.tmpdir(), 'gsd-3309-onelevel-'));
|
||||
t.after(() => cleanup(dir));
|
||||
buildSubdirTree(dir, { subdir: ['keep.cjs', 'skip.md', 'skip.json'] });
|
||||
|
||||
assert.deepStrictEqual(collectOneLevelSubdirs({ dir, filter: CJS_ONLY }), ['subdir/keep.cjs']);
|
||||
});
|
||||
|
||||
test('collectOneLevelSubdirs does not recurse past one level', (t) => {
|
||||
const dir = fs.mkdtempSync(path.join(os.tmpdir(), 'gsd-3309-onelevel-'));
|
||||
t.after(() => cleanup(dir));
|
||||
buildSubdirTree(dir, { subdir: ['top.cjs'] });
|
||||
const deep = path.join(dir, 'subdir', 'deeper');
|
||||
fs.mkdirSync(deep, { recursive: true });
|
||||
fs.writeFileSync(path.join(deep, 'too-deep.cjs'), '// fixture\n');
|
||||
|
||||
assert.deepStrictEqual(collectOneLevelSubdirs({ dir, filter: CJS_ONLY }), ['subdir/top.cjs']);
|
||||
});
|
||||
|
||||
test('collectOneLevelSubdirs on a missing dir contributes nothing rather than throwing', () => {
|
||||
assert.deepStrictEqual(
|
||||
collectOneLevelSubdirs({ dir: path.join(os.tmpdir(), 'gsd-3309-does-not-exist'), filter: CJS_ONLY }),
|
||||
[],
|
||||
);
|
||||
});
|
||||
|
||||
test('collectOneLevelSubdirs skips a dangling symlink without crashing the walk', (t) => {
|
||||
if (process.platform === 'win32') {
|
||||
t.skip('symlink creation requires elevation on Windows; the unstattable-entry path is asserted on macOS + Linux');
|
||||
return;
|
||||
}
|
||||
|
||||
const dir = fs.mkdtempSync(path.join(os.tmpdir(), 'gsd-3309-onelevel-'));
|
||||
t.after(() => cleanup(dir));
|
||||
buildSubdirTree(dir, { subdir: ['real.cjs'] });
|
||||
fs.symlinkSync(path.join(dir, 'subdir', 'nope.cjs'), path.join(dir, 'subdir', 'dangling.cjs'));
|
||||
|
||||
assert.deepStrictEqual(
|
||||
collectOneLevelSubdirs({ dir, filter: CJS_ONLY }),
|
||||
['subdir/real.cjs'],
|
||||
'one unreadable entry must not take down the whole scan',
|
||||
);
|
||||
});
|
||||
|
||||
Reference in New Issue
Block a user