Skip to content

ci: enforce tool metadata sync #43

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
alloutflo wants to merge 2 commits into
base: main
Choose a base branch
from
Open

ci: enforce tool metadata sync #43

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
897ad92
ci: enforce tool metadata sync
alloutflo Aug 9, 2026
32eeebc
Remove unrelated .DS_Store ignore rule
alloutflo Aug 9, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 36 additions & 4 deletions scripts/check-tool-count.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,42 @@
#!/usr/bin/env bun
// Fails if README.md tool counts drift from TOOL_COUNT. README cannot import the
// constant, so this greps it and asserts. Run in CI on every PR.
// Fails if the runtime and display tool rosters diverge, or if README.md tool
// counts drift from TOOL_COUNT. Run in CI on every PR.

import { readFileSync } from "node:fs";
import { join } from "node:path";
import { TOOL_COUNT } from "../src/tools-meta";
import { TOOL_CONFIGS } from "../src/tool-configs";
import { TOOL_COUNT, TOOL_NAMES } from "../src/tools-meta";

const root = join(import.meta.dir, "..");
const readme = readFileSync(join(root, "README.md"), "utf-8");
let failed = false;

// "global-agents" is the shared ~/.agents/skills directory, not a coding tool.
const configuredToolNames = TOOL_CONFIGS.filter(({ id }) => id !== "global-agents").map(
({ name }) => name,
);
const configuredToolNameSet = new Set<string>(configuredToolNames);
const displayToolNameSet = new Set<string>(TOOL_NAMES);
const missingDisplayNames = configuredToolNames.filter((name) => !displayToolNameSet.has(name));
const staleDisplayNames = TOOL_NAMES.filter((name) => !configuredToolNameSet.has(name));

if (
configuredToolNames.length !== TOOL_COUNT ||
missingDisplayNames.length > 0 ||
staleDisplayNames.length > 0
) {
console.error(
`Tool roster drift: tool-configs.ts has ${configuredToolNames.length} coding tools, ` +
`but tools-meta.ts has ${TOOL_COUNT}.`,
);
if (missingDisplayNames.length > 0) {
console.error(` Missing from TOOL_NAMES: ${missingDisplayNames.join(", ")}`);
}
if (staleDisplayNames.length > 0) {
console.error(` Missing from TOOL_CONFIGS: ${staleDisplayNames.join(", ")}`);
}
failed = true;
}

// Every standalone "N coding agents", "N tools", "N coding assistants" number in the README.
const pattern = /\b(\d+)\s+(?:coding agents|coding assistants|tools|AI coding tools|coding tools)\b/g;
Expand All @@ -23,7 +52,10 @@ if (bad.length > 0) {
console.error(`README tool count drift (TOOL_COUNT is ${TOOL_COUNT}):`);
console.error(bad.join("\n"));
console.error("\nUpdate README.md, or update TOOL_COUNT in src/tools-meta.ts if a tool was added.");
process.exit(1);
failed = true;
}

if (failed) process.exit(1);

console.log(`Runtime and display tool rosters match (${TOOL_COUNT} coding tools).`);
console.log(`README tool counts match TOOL_COUNT (${TOOL_COUNT}).`);
Loading