fix(ci): enforce catalog count integrity (#525)

* fix(ci): enforce catalog count integrity

* test: harden catalog structure parsing
This commit is contained in:
Justin Philpott
2026-03-16 20:37:51 +00:00
committed by GitHub
parent ac53fbcd0e
commit 01ed1b3b03
6 changed files with 173 additions and 16 deletions

View File

@@ -140,6 +140,68 @@ function runValidator(validatorName) {
}
}
function runCatalogValidator(overrides = {}) {
const validatorPath = path.join(validatorsDir, 'catalog.js');
let source = fs.readFileSync(validatorPath, 'utf8');
source = source.replace(/^#!.*\n/, '');
source = `process.argv.push('--text');\n${source}`;
const resolvedOverrides = {
ROOT: repoRoot,
README_PATH: path.join(repoRoot, 'README.md'),
AGENTS_PATH: path.join(repoRoot, 'AGENTS.md'),
...overrides,
};
for (const [constant, overridePath] of Object.entries(resolvedOverrides)) {
const dirRegex = new RegExp(`const ${constant} = .*?;`);
source = source.replace(dirRegex, `const ${constant} = ${JSON.stringify(overridePath)};`);
}
try {
const stdout = execFileSync('node', ['-e', source], {
encoding: 'utf8',
stdio: ['pipe', 'pipe', 'pipe'],
timeout: 10000,
});
return { code: 0, stdout, stderr: '' };
} catch (err) {
return {
code: err.status || 1,
stdout: err.stdout || '',
stderr: err.stderr || '',
};
}
}
function writeCatalogFixture(testDir, options = {}) {
const {
readmeCounts = { agents: 1, skills: 1, commands: 1 },
summaryCounts = { agents: 1, skills: 1, commands: 1 },
structureLines = [
'agents/ — 1 specialized subagents',
'skills/ — 1 workflow skills and domain knowledge',
'commands/ — 1 slash commands',
],
} = options;
const readmePath = path.join(testDir, 'README.md');
const agentsPath = path.join(testDir, 'AGENTS.md');
fs.mkdirSync(path.join(testDir, 'agents'), { recursive: true });
fs.mkdirSync(path.join(testDir, 'commands'), { recursive: true });
fs.mkdirSync(path.join(testDir, 'skills', 'demo-skill'), { recursive: true });
fs.writeFileSync(path.join(testDir, 'agents', 'planner.md'), '---\nmodel: sonnet\ntools: Read\n---\n# Planner');
fs.writeFileSync(path.join(testDir, 'commands', 'plan.md'), '---\ndescription: Plan\n---\n# Plan');
fs.writeFileSync(path.join(testDir, 'skills', 'demo-skill', 'SKILL.md'), '---\nname: demo-skill\ndescription: Demo skill\norigin: ECC\n---\n# Demo Skill');
fs.writeFileSync(readmePath, `Access to ${readmeCounts.agents} agents, ${readmeCounts.skills} skills, and ${readmeCounts.commands} commands.\n| Feature | Claude Code | Cursor IDE | Codex CLI | OpenCode |\n|---------|------------|------------|-----------|----------|\n| Agents | ✅ ${readmeCounts.agents} agents | Shared | Shared | 1 |\n| Commands | ✅ ${readmeCounts.commands} commands | Shared | Shared | 1 |\n| Skills | ✅ ${readmeCounts.skills} skills | Shared | Shared | 1 |\n`);
fs.writeFileSync(agentsPath, `This is a **production-ready AI coding plugin** providing ${summaryCounts.agents} specialized agents, ${summaryCounts.skills} skills, ${summaryCounts.commands} commands, and automated hook workflows for software development.\n\n\`\`\`\n${structureLines.join('\n')}\n\`\`\`\n`);
return { readmePath, agentsPath };
}
function runTests() {
console.log('\n=== Testing CI Validators ===\n');
@@ -262,6 +324,60 @@ function runTests() {
assert.ok(result.stdout.includes('Validated'), 'Should output validation count');
})) passed++; else failed++;
// ==========================================
// catalog.js
// ==========================================
console.log('\ncatalog.js:');
if (test('passes on real project catalog counts', () => {
const result = runCatalogValidator();
assert.strictEqual(result.code, 0, `Should pass, got stderr: ${result.stderr}`);
assert.ok(result.stdout.includes('Documentation counts match the repository catalog.'), 'Should report matching counts');
})) passed++; else failed++;
if (test('fails when README and AGENTS catalog counts drift', () => {
const testDir = createTestDir();
const { readmePath, agentsPath } = writeCatalogFixture(testDir, {
readmeCounts: { agents: 99, skills: 99, commands: 99 },
summaryCounts: { agents: 99, skills: 99, commands: 99 },
structureLines: [
'agents/ — 99 specialized subagents',
'skills/ — 99 workflow skills and domain knowledge',
'commands/ — 99 slash commands',
],
});
const result = runCatalogValidator({
ROOT: testDir,
README_PATH: readmePath,
AGENTS_PATH: agentsPath,
});
assert.strictEqual(result.code, 1, 'Should fail when catalog counts drift');
assert.ok((result.stdout + result.stderr).includes('Documentation count mismatches found:'), 'Should report mismatches');
cleanupTestDir(testDir);
})) passed++; else failed++;
if (test('accepts AGENTS project structure entries with varied spacing and dash styles', () => {
const testDir = createTestDir();
const { readmePath, agentsPath } = writeCatalogFixture(testDir, {
structureLines: [
' agents/ - 1 specialized subagents ',
'\tskills/\t\t1+ workflow skills and domain knowledge\t',
' commands/ — 1 slash commands ',
],
});
const result = runCatalogValidator({
ROOT: testDir,
README_PATH: readmePath,
AGENTS_PATH: agentsPath,
});
assert.strictEqual(result.code, 0, `Should accept formatting variations, got stderr: ${result.stderr}`);
cleanupTestDir(testDir);
})) passed++; else failed++;
if (test('exits 0 when hooks.json does not exist', () => {
const result = runValidatorWithDir('validate-hooks', 'HOOKS_FILE', '/nonexistent/hooks.json');
assert.strictEqual(result.code, 0, 'Should skip when no hooks.json');