#!/usr/bin/env node // repo-standard โ€” the per-repo gate. // // Checks ONE repository against the standard for its class: // - README first screen: H1 is the repo name, next line IS the forge description // - Install block complete, in the form its class actually uses // - Required files present for its class // - Every `open/` reference in URL position resolves // - Description within the length bound, measured in codepoints // // What it deliberately does NOT do: anything that needs to see all repos at once. // Divergence across the org (0/18 topics, three competing install forms, README // release notes duplicating a CHANGELOG that 16 of 18 repos have) is invisible // from inside one repo. Those checks live in org-ops, not here. // // Structure mirrors the marketplace's check-versions.mjs on purpose: pure // classifiers with all I/O resolved into their input, findings tagged // ERROR/WARN/SKIP/OK, exit 1 on ERROR. This is a gate, not a checklist โ€” // the catalog's eleven descriptions are good because a gate runs on them; the // forge's nine were empty. Same care, different outcome. // // Usage: // node scripts/repo-standard-check.mjs [--dir ] [--name ] [--offline] [--json] // node scripts/repo-standard-check.mjs --refresh # register vs. live org listing import { readFileSync, existsSync } from 'node:fs'; import { execFileSync } from 'node:child_process'; import { join, dirname, basename } from 'node:path'; import { fileURLToPath } from 'node:url'; const HERE = dirname(fileURLToPath(import.meta.url)); const REGISTER_PATH = join(HERE, '..', 'register', 'repos.json'); const LEVELS = ['OK', 'SKIP', 'WARN', 'ERROR']; // Findings carry a level AND a bucket, and the two are independent axes. // The level says how sure and how loud; the bucket says what KIND of problem it // is, which is what a reader triages on: // // broken works wrongly right now โ€” a stranger is blocked or misled // missing an expected artefact is simply absent // weakening present and functional, but it reads as amateur // // A weakening finding can still be an ERROR: a README opening line that // contradicts the published description blocks nobody, and is still wrong. export const BUCKETS = ['broken', 'missing', 'weakening']; // ------------------------------------------------------------ pure helpers // Codepoints. Not bytes (an em-dash costs 3) and not UTF-16 units (`๐Ÿ‘‰` costs 2). // The em-dash exposes only the outer layer, which is why "characters, not bytes" // was not enough on its own. export function countCodepoints(s) { return [...String(s ?? '')].length; } // ~20 "dead" repo names collapsed to 3 real ones once this ran. A clone URL // ending in .git is a legitimate reference, not a broken one. export function normalizeRepoRef(raw) { return String(raw ?? '') .replace(/\/+$/, '') .replace(/\.git$/, ''); } // Only names in URL position are resolvable references. That single rule // excludes all three of the measured "correct text that looks broken" cases at // once: a path position (`~/.claude/coord/_broadcast/`), running prose (`coord` // is still the transport protocol's name), and a bare directory name. const URL_REF = /(?::\/\/[^\s)\]"'`]*\/|@[^\s:]+:)open\/([A-Za-z0-9._-]+)/g; export function extractOpenRefs(text) { const out = []; const lines = String(text ?? '').split('\n'); lines.forEach((line, i) => { for (const m of line.matchAll(URL_REF)) { out.push({ name: normalizeRepoRef(m[1]), line: i + 1, raw: m[0] }); } }); return out; } // Three outcomes, never two. "No match" and "match on something that is not a // repo" must stay distinguishable โ€” if they share an outcome, the loss goes // silent, and silent loss is the defect class this standard exists to catch. export function classifyRef(name, register) { if (Object.prototype.hasOwnProperty.call(register.repos ?? {}, name)) return 'repo'; if (Object.prototype.hasOwnProperty.call(register.non_repos ?? {}, name)) return 'non-repo'; return 'unknown'; } export function checkLinks({ files }, register) { const findings = []; for (const [path, text] of Object.entries(files ?? {})) { for (const ref of extractOpenRefs(text)) { const kind = classifyRef(ref.name, register); if (kind === 'repo') continue; if (kind === 'non-repo') { findings.push({ level: 'WARN', code: 'LINK-NON-REPO', bucket: 'weakening', msg: `${path}:${ref.line} โ€” \`open/${ref.name}\` resolves to a known non-repo: ${register.non_repos[ref.name]}`, }); } else { findings.push({ level: 'ERROR', code: 'LINK-DEAD', bucket: 'broken', msg: `${path}:${ref.line} โ€” \`open/${ref.name}\` matches no repo in the register (dead reference)`, }); } } } return findings; } export function checkDescription(description, register) { if (description === null || description === undefined) { return [{ level: 'SKIP', code: 'DESC-UNAVAILABLE', msg: 'forge description not available โ€” check not run (offline, or the listing failed)' }]; } const max = register.description_max_codepoints ?? 180; const n = countCodepoints(description); if (n === 0) return [{ level: 'ERROR', code: 'DESC-EMPTY', bucket: 'missing', msg: 'forge description is empty' }]; if (n > max) { return [{ level: 'ERROR', code: 'DESC-TOO-LONG', bucket: 'weakening', msg: `forge description is ${n} codepoints, bound is ${max}` }]; } return [{ level: 'OK', code: 'DESC', msg: `description ${n}/${max} codepoints` }]; } // The opening line makes description == catalog == README: the same thread on a // third surface, and the only one of the three a machine can check from inside // the repo. export function checkFirstScreen({ readme, name, description }) { const findings = []; const lines = String(readme ?? '').split('\n'); const firstIdx = lines.findIndex((l) => l.trim() !== ''); const heading = firstIdx === -1 ? null : lines[firstIdx].trim(); // No heading at all is broken. A heading that merely differs from the repo // name is not: the thread that has to hold is description == catalog == // opening line, and the H1 is none of those three. A human title like // `# OKR for Public Sector` is a naming choice the operator owns, so it is // surfaced and left to them โ€” a gate that fails a correct repo is the // mechanism that gets gates switched off. if (heading === null || !heading.startsWith('# ')) { findings.push({ level: 'ERROR', code: 'README-H1', bucket: 'missing', msg: `README must open with an H1 (expected \`# ${name}\`, found: ${heading === null ? '' : `\`${heading}\``})`, }); return findings; } if (heading !== `# ${name}`) { findings.push({ level: 'WARN', code: 'README-H1', bucket: 'weakening', msg: `H1 is \`${heading}\`, not \`# ${name}\` โ€” deliberate title, or drift? Operator's call.`, }); } else { findings.push({ level: 'OK', code: 'README-H1', msg: `H1 is \`# ${name}\`` }); } if (description === null || description === undefined) { findings.push({ level: 'SKIP', code: 'README-DESC', msg: 'forge description not available โ€” opening-line match not checked' }); return findings; } const restIdx = lines.findIndex((l, i) => i > firstIdx && l.trim() !== ''); const opening = restIdx === -1 ? '' : lines[restIdx].trim(); if (opening !== String(description).trim()) { findings.push({ level: 'ERROR', code: 'README-DESC', bucket: 'weakening', msg: `README opening line does not match the forge description\n README: ${opening}\n forge: ${description}`, }); } else { findings.push({ level: 'OK', code: 'README-DESC', msg: 'opening line matches the forge description' }); } return findings; } // `claude plugin install x@mkt` or `/plugin install x@mkt` โ€” the two CLI forms. function hasCliInstall(readme, name, mkt) { const esc = (s) => String(s).replace(/[.*+?^${}()|[\]\\]/g, '\\$&'); return new RegExp(`(?:claude\\s+plugin|/plugin)\\s+install\\s+${esc(name)}@${esc(mkt)}\\b`).test(readme); } function hasAnyPluginInstall(readme) { return /(?:claude\s+plugin|\/plugin)\s+install\s+\S+@\S+/.test(readme); } export function checkInstallBlock({ readme, name, klass }, register) { const form = register.classes?.[klass]?.install ?? 'none'; const text = String(readme ?? ''); const mkt = register.marketplace ?? {}; const findings = []; if (form === 'none') return findings; const addLines = text.split('\n').filter((l) => /plugin\s+marketplace\s+add/.test(l)); const hasAdd = addLines.length > 0; // The forge UI's clone button hands out the ssh URL, and `marketplace add` // answers it with "Invalid git URL" โ€” a message that never mentions the // protocol. Measured end-to-end 2026-07-25. if (addLines.some((l) => /ssh:\/\//.test(l))) { findings.push({ level: 'ERROR', code: 'INSTALL-SSH', bucket: 'broken', msg: '`marketplace add` is shown with an ssh:// URL โ€” it rejects those ("Invalid git URL"). Use the https form.', }); } // A well-formed command pointing at the wrong marketplace is still a command // that does not work. Checked against the register, so it needs no network. if (hasAdd && mkt.url) { const urls = addLines .map((l) => /marketplace\s+add\s+(\S+)/.exec(l)?.[1]) .filter(Boolean) .map((u) => u.replace(/[`'"]+$/, '')); if (urls.length && !urls.some((u) => normalizeRepoRef(u) === normalizeRepoRef(mkt.url))) { findings.push({ level: 'ERROR', code: 'INSTALL-URL-MISMATCH', bucket: 'broken', msg: `\`marketplace add\` points at ${urls[0]}, but this marketplace is ${mkt.url}`, }); } } if (form === 'plugin' || form === 'catalog') { if (!hasAdd) { findings.push({ level: 'ERROR', code: 'INSTALL-NO-MARKETPLACE', bucket: 'broken', msg: `no \`plugin marketplace add\` line โ€” the reader is never told to add \`${mkt.name}\` (${mkt.url})`, }); } else { findings.push({ level: 'OK', code: 'INSTALL-MARKETPLACE', msg: '`marketplace add` present' }); } } if (form === 'plugin') { // The corrected defect A. `enabledPlugins` in settings.json is a LEGITIMATE // second form and it stands in 10 of 11 plugin READMEs โ€” what is missing in // 7 of them is a CLI command. So the contract requires the command and // permits the JSON alongside it; it never accepts the JSON as a substitute. // A reader who scrolls to the JSON block has a complete path; an agent told // "install this" reaches for the CLI and finds `marketplace add` and nothing else. if (!hasCliInstall(text, name, mkt.name)) { findings.push({ level: 'ERROR', code: 'INSTALL-NO-CLI', bucket: 'broken', msg: `no CLI install command for this repo โ€” expected \`claude plugin install ${name}@${mkt.name}\` (or the \`/plugin install\` form). An \`enabledPlugins\` block is a welcome addition, but it is not a CLI command.`, }); } else { findings.push({ level: 'OK', code: 'INSTALL-CLI', msg: `CLI install command names ${name}@${mkt.name}` }); } } if (form === 'vendor' && hasAnyPluginInstall(text)) { findings.push({ level: 'ERROR', code: 'INSTALL-WRONG-FORM', bucket: 'broken', msg: 'shared asset shows a plugin install line โ€” it is vendored into consumers, not installed. Document how to vendor it.', }); } if (form === 'package') { if (hasAnyPluginInstall(text)) { findings.push({ level: 'ERROR', code: 'INSTALL-WRONG-FORM', bucket: 'broken', msg: 'standalone project shows a plugin install line โ€” use the pip/uv form.', }); } else if (!/\b(pip\s+install|uv\s+(?:pip\s+)?(?:add|sync|install|run)|uvx)\b/.test(text)) { findings.push({ level: 'WARN', code: 'INSTALL-NO-PACKAGE-FORM', bucket: 'missing', msg: 'no pip/uv install form found โ€” expected for a standalone project', }); } } return findings; } // Per class, never flat. A flat standard demands a CONTRIBUTING from a CSS // library that takes no contributions and a ROADMAP from a five-line profile. // Syntax is not truth. The most disqualifying failure a repo can have is an // install command that does not work for a stranger, and a perfectly formed // `claude plugin install x@mkt` fails silently if `x` was never pinned in the // catalog. This is the one check that answers the brief's first question. export function checkInstallTruth({ name, klass, catalogNames }) { if (klass !== 'plugin') return [{ level: 'OK', code: 'INSTALL-TRUTH', msg: 'not a marketplace plugin โ€” nothing to resolve' }]; if (!catalogNames) { return [{ level: 'SKIP', code: 'INSTALL-TRUTH', msg: 'catalog not reachable โ€” cannot verify the install command actually resolves' }]; } if (!catalogNames.includes(name)) { return [{ level: 'ERROR', code: 'INSTALL-NOT-IN-CATALOG', bucket: 'broken', msg: `\`${name}\` is not pinned in the marketplace catalog โ€” the documented install command cannot succeed for anyone`, }]; } return [{ level: 'OK', code: 'INSTALL-TRUTH', msg: 'the install command resolves against the catalog' }]; } // Requirements come from two axes. The CLASS is structural โ€” it can be read off // the catalog and the remotes. A TRAIT is about what the code does, which no // remote can tell you: `security` attaches the obligations a tool acquires by // handling untrusted input. // // Note what is NOT here: CONTRIBUTING, CODE_OF_CONDUCT, MAINTAINERS. The // maintainer works alone and the published stance says so. Contributor-facing // documentation for a project that accepts no contributors is theatre, and a // code of conduct with an unattended placeholder address is worse than none. // Consumer-facing documents are untouched by that โ€” SECURITY.md exists for the // outsider who finds a hole, and being solo does not remove them. function requirementsFor(klass, traits, register) { const cls = register.classes?.[klass] ?? {}; const files = [...(cls.required_files ?? [])]; const headings = [...(cls.required_headings ?? [])]; for (const t of traits ?? []) { const tr = register.trait_requirements?.[t]; if (!tr) continue; for (const f of tr.required_files ?? []) if (!files.includes(f)) files.push(f); for (const h of tr.required_headings ?? []) if (!headings.includes(h)) headings.push(h); } return { files, headings }; } export function checkRequiredFiles({ present, klass, traits }, register) { const { files: required } = requirementsFor(klass, traits, register); const have = new Set(present ?? []); const findings = []; for (const f of required) { if (!have.has(f)) { findings.push({ level: 'ERROR', code: 'FILE-MISSING', bucket: 'missing', msg: `missing required file for class \`${klass}\`: ${f}` }); } } if (findings.length === 0 && required.length > 0) { findings.push({ level: 'OK', code: 'FILES', msg: `all ${required.length} required files present` }); } return findings; } // Fixed headings, because experienced readers skip rather than read. `## Install` // on a predictable heading is what agents pattern-match on, and `## Non-goals` // is the cheapest trust-builder there is: it proves someone thought about the // boundary, and it stops misuse before it starts. export function checkHeadings({ readme, klass, traits }, register) { const { headings: required } = requirementsFor(klass, traits, register); const text = String(readme ?? ''); const present = new Set( text.split('\n').map((l) => l.trim()).filter((l) => l.startsWith('#')), ); const findings = []; for (const h of required) { if ([...present].some((p) => p.toLowerCase() === h.toLowerCase())) continue; // Same title, wrong depth: say that, rather than "missing". The contract // wants a predictable top-level heading because that is what an agent // pattern-matches on โ€” but the section does exist, and the fix is a // different edit than writing one from scratch. const title = h.replace(/^#+\s*/, ''); const atOtherLevel = [...present].find( (p) => p.replace(/^#+\s*/, '').toLowerCase() === title.toLowerCase(), ); if (atOtherLevel) { findings.push({ level: 'ERROR', code: 'HEADING-LEVEL', bucket: 'weakening', msg: `README has \`${atOtherLevel}\` but the contract wants \`${h}\` โ€” a predictable top-level heading is what readers and agents scan for`, }); } else { findings.push({ level: 'ERROR', code: 'HEADING-MISSING', bucket: 'missing', msg: `README has no \`${h}\` section` }); } } if (findings.length === 0 && required.length > 0) { findings.push({ level: 'OK', code: 'HEADINGS', msg: `all ${required.length} required headings present` }); } return findings; } // One version, four places it can be written down. This is the check that // removes a whole defect class โ€” "README says v0.3.1, the tag does not exist" โ€” // and the one that would have caught this repo's own 32โ†’34 test-count drift. export function checkVersionConsistency({ pluginVersion, readmeBadge, changelogTop, tags }) { const findings = []; const v = pluginVersion ? String(pluginVersion).replace(/^v/, '') : null; if (!v) { return [{ level: 'SKIP', code: 'VERSION-UNAVAILABLE', msg: 'no package version found โ€” nothing to compare against' }]; } if (readmeBadge !== null && readmeBadge !== undefined && readmeBadge !== v) { findings.push({ level: 'ERROR', code: 'VERSION-BADGE', bucket: 'weakening', msg: `README version badge is ${readmeBadge}, manifest says ${v}` }); } if (changelogTop !== null && changelogTop !== undefined && changelogTop !== v) { findings.push({ level: 'ERROR', code: 'VERSION-CHANGELOG', bucket: 'weakening', msg: `newest CHANGELOG entry is ${changelogTop}, manifest says ${v}` }); } // Nothing released yet is a state, not a defect โ€” and it must say so rather // than pass quietly, because "SKIP is never a pass" is the whole discipline. if (!tags || tags.length === 0) { findings.push({ level: 'SKIP', code: 'VERSION-TAG', msg: `repo has no tags โ€” cannot verify that v${v} was ever released` }); } else if (!tags.includes(`v${v}`)) { findings.push({ level: 'ERROR', code: 'VERSION-TAG', bucket: 'broken', msg: `no tag \`v${v}\` โ€” the documented version was never released (tags: ${tags.slice(-3).join(', ')})` }); } if (findings.every((f) => f.level === 'OK' || f.level === 'SKIP')) { findings.push({ level: 'OK', code: 'VERSION', msg: `version ${v} agrees across manifest, README and CHANGELOG` }); } return findings; } // A static image asserting "tests: 642 passing" is a claim dressed as evidence. // Version, licence and platform badges assert no run, so they are fine static. const CLAIM_BADGE = /(tests?|build|ci|coverage|passing|status)/i; export function checkBadges({ readme }) { const findings = []; for (const line of String(readme ?? '').split('\n')) { // Any image, any host. Restricting this to img.shields.io would have missed // a self-hosted SVG asserting exactly the same unverified thing. for (const m of line.matchAll(/(\[)?!\[([^\]]*)\]\(([^)\s]+)\)(\])?/g)) { const linked = m[1] === '[' && m[4] === ']'; const label = `${m[2]} ${m[3]}`; if (!linked && CLAIM_BADGE.test(label)) { findings.push({ level: 'WARN', code: 'BADGE-STATIC-CLAIM', bucket: 'weakening', msg: `static badge asserts a run that nothing verifies: \`${m[2]}\`. A badge like this is a claim dressed as evidence โ€” link it to a real run, or drop it.`, }); } } } if (findings.length === 0) findings.push({ level: 'OK', code: 'BADGES', msg: 'no static badge asserts an unverified run' }); return findings; } // Template text that was never filled in. A visible unfinished template costs // more trust than the missing document would have. const BOILERPLATE = [ /your-project-name/i, /\byour-org\b/i, /\[INSERT[^\]]*\]/i, //i, /TODO:\s*(fill|replace|update)/i, /example@example\.(com|org)/i, /FIXME/, ]; export function checkBoilerplate({ files }) { const findings = []; for (const [path, text] of Object.entries(files ?? {})) { // Same discipline as the link check: code spans and fenced blocks are where // a document ABOUT placeholders keeps its examples. stripCode(text).split('\n').forEach((line, i) => { for (const re of BOILERPLATE) { if (re.test(line)) { findings.push({ level: 'WARN', code: 'BOILERPLATE', bucket: 'weakening', msg: `${path}:${i + 1} โ€” unfilled template text: \`${line.trim().slice(0, 70)}\``, }); return; } } }); } if (findings.length === 0) findings.push({ level: 'OK', code: 'BOILERPLATE', msg: 'no unfilled template text found' }); return findings; } // "LICENSE mentioned in the README, no file in the repo" is its own anti-signal: // the claim is load-bearing for anyone deciding whether they may use this. export function checkLicenseClaim({ readme, present }) { const text = String(readme ?? ''); const claims = /\bLICEN[SC]E\b/i.test(text) || /\b(MIT|Apache|BSD|GPL)\b.{0,20}licen[sc]e/i.test(text); const have = (present ?? []).some((f) => /^LICEN[SC]E(\.\w+)?$/i.test(f)); if (claims && !have) { return [{ level: 'ERROR', code: 'LICENSE-CLAIMED-ABSENT', bucket: 'broken', msg: 'README cites a licence but the repo has no LICENSE file โ€” the claim a reader relies on to use this is unbacked', }]; } return [{ level: 'OK', code: 'LICENSE-CLAIM', msg: have ? 'LICENSE present' : 'no licence claim to back' }]; } // Blank out fenced blocks and inline code spans, keeping line numbers intact. // Documentation about regexes is full of strings that ARE markdown links to a // naive scanner: `["']([A-Za-z0-9\-._]{16,64})["']` is `[...](...)` exactly. // Running the first version against a real repo produced ~30 findings and every // one of them was noise. export function stripCode(text) { let fenced = false; let prevBlank = true; let inIndented = false; return String(text ?? '') .split('\n') .map((line) => { if (/^\s*(```|~~~)/.test(line)) { fenced = !fenced; return ''; } if (fenced) return ''; const blank = line.trim() === ''; const indented = /^(\s{4,}|\t)\S/.test(line); // An indented line OPENS a code block only after a blank line โ€” otherwise // a nested list item would count, which made links inside nested bullets // invisible. But once open, the block CONTINUES while lines stay indented; // requiring a blank line before every line let everything after line 1 // leak back into scanning. if (indented && (prevBlank || inIndented)) { inIndented = true; prevBlank = false; return ''; } if (!blank && !indented) inIndented = false; prevBlank = blank; if (inIndented && blank) return ''; return line.replace(/`[^`]*`/g, ''); }) .join('\n'); } // A relative link resolves against the file it sits in, not against the repo // root. Getting this wrong called two files missing that were right there next // to the README linking them โ€” and it would have done so in every nested doc. // Returns null when the path escapes the repo, which is unresolvable from // inside one repo rather than broken. export function resolveRelative(fromFile, target) { if (target.startsWith('/')) return null; const baseParts = String(fromFile).split('/').slice(0, -1); const out = [...baseParts]; for (const part of target.split('/')) { if (part === '' || part === '.') continue; if (part === '..') { if (out.length === 0) return null; out.pop(); } else { out.push(part); } } return out.join('/'); } // Who the reader is decides the level. A dead link in a root document โ€” README, // CHANGELOG, SECURITY โ€” is in the shop window and blocks a stranger. The same // link three directories down is in a session plan, an agent working file, or a // test fixture whose target is invalid ON PURPOSE. Measured across the org: 30 // of 43 findings sat below the root, and every one of them was an ERROR. A gate // that is wrong that often gets switched off, so the level moves โ€” and only the // level. The finding is still reported, with its file and line. function linkLevelFor(path) { return String(path).includes('/') ? 'WARN' : 'ERROR'; } // Relative file links only. Anchor resolution depends on per-renderer heading // slug rules and is a rabbit hole; external URLs need the network. Both are // deliberately out โ€” a check that is sometimes wrong teaches people to ignore it. export function checkInternalLinks({ files, present }) { const have = new Set(present ?? []); const findings = []; for (const [path, text] of Object.entries(files ?? {})) { stripCode(text).split('\n').forEach((line, i) => { for (const m of line.matchAll(/\[[^\]]*\]\(([^)\s]+)\)/g)) { const target = m[1]; // Any scheme at all, not just http โ€” `file:`, `vscode:`, `ftp:` are all // somebody else's to resolve. if (/^[a-z][a-z0-9+.-]*:/i.test(target) || /^[#<]/.test(target)) continue; const clean = target.split('#')[0]; if (!clean) continue; const resolved = resolveRelative(path, clean); // A path that leaves the repo cannot be judged from inside it โ€” a // plugin README pointing up at its marketplace is the ordinary case. if (resolved === null) { findings.push({ level: 'SKIP', code: 'LINK-OUTSIDE-REPO', msg: `${path}:${i + 1} โ€” \`${clean}\` points outside this repo; the gate sees one repo and cannot resolve it`, }); continue; } if (!have.has(resolved)) { findings.push({ level: linkLevelFor(path), code: 'LINK-INTERNAL-MISSING', bucket: 'broken', msg: `${path}:${i + 1} โ€” link points at \`${clean}\` (${resolved}), which is not a tracked file`, }); } } }); } // The OK line asserts that every link resolved. Keying it on ERROR alone would // have printed it beside a pile of WARN findings saying the opposite. if (!findings.some((f) => f.code === 'LINK-INTERNAL-MISSING')) { findings.push({ level: 'OK', code: 'LINKS-INTERNAL', msg: 'every resolvable relative link resolves' }); } return findings; } export function levelOf(findings) { let worst = 'OK'; for (const f of findings ?? []) { if (LEVELS.indexOf(f.level) > LEVELS.indexOf(worst)) worst = f.level; } return worst; } export function bucketsOf(findings) { const out = { broken: 0, missing: 0, weakening: 0 }; for (const f of findings ?? []) { if (f.bucket && out[f.bucket] !== undefined) out[f.bucket] += 1; } return out; } export function classifyRepo( { name, files, present, description, pluginVersion, readmeBadge, changelogTop, tags, catalogNames }, register, ) { const klass = register.repos?.[name]; if (!klass) { return { name, klass: null, traits: [], status: 'SKIP', buckets: { broken: 0, missing: 0, weakening: 0 }, findings: [{ level: 'SKIP', code: 'REPO-UNREGISTERED', msg: `\`${name}\` is not in the register โ€” class unknown, so no class-specific rule can be applied. Add it to register/repos.json (or run --refresh).`, }], }; } const traits = register.traits?.[name] ?? []; const readme = (files ?? {})['README.md'] ?? ''; const findings = [ ...checkFirstScreen({ readme, name, description }), ...checkInstallBlock({ readme, name, klass }, register), ...checkInstallTruth({ name, klass, catalogNames }), ...checkHeadings({ readme, klass, traits }, register), ...checkRequiredFiles({ present, klass, traits }, register), ...checkLinks({ files }, register), ...checkInternalLinks({ files, present }), ...checkLicenseClaim({ readme, present }), ...checkBadges({ readme }), ...checkBoilerplate({ files }), ...checkVersionConsistency({ pluginVersion, readmeBadge, changelogTop, tags }), ...checkDescription(description, register), ]; return { name, klass, traits, status: levelOf(findings), buckets: bucketsOf(findings), findings }; } // ---------------------------------------------------------------- I/O shell export function loadRegister(path = REGISTER_PATH) { return JSON.parse(readFileSync(path, 'utf8')); } // ONE call. The org listing already carries description and topics; fetching // per repo trips the rate limiter (HTTP 429). Reads anonymously โ€” verified โ€” // so this works for any reader, not only for someone holding a token. // The catalog's plugin list, read straight from the forge. One more call, and // it is what turns "the install line is well-formed" into "the install line // works". Null on any failure, which reads as SKIP rather than a pass. async function fetchCatalogNames(register) { const mkt = register.marketplace ?? {}; if (!mkt.name) return null; const url = `${register.forge}/api/v1/repos/${register.org}/${mkt.name}/raw/.claude-plugin/marketplace.json`; try { const res = await fetch(url, { headers: { accept: 'application/json' } }); if (!res.ok) return null; const json = JSON.parse(await res.text()); return (json.plugins ?? []).map((p) => p.name).filter(Boolean); } catch { return null; } } async function fetchOrgListing(register) { const url = `${register.forge}/api/v1/orgs/${register.org}/repos?limit=50`; const res = await fetch(url, { headers: { accept: 'application/json' } }); if (!res.ok) throw new Error(`org listing returned HTTP ${res.status}`); return res.json(); } function gitFiles(dir) { try { return execFileSync('git', ['-C', dir, 'ls-files'], { encoding: 'utf8' }) .split('\n') .map((s) => s.trim()) .filter(Boolean); } catch { return null; } } // The remote is ground truth for what a repo is CALLED; the directory is only // where it happens to sit. `catalog/` is the working directory of the repo named // `ktg-plugin-marketplace`, and deriving the name from the basename left it // REPO-UNREGISTERED โ€” zero checks run against the one repo the catalog rule // depends on. Handles the scp form too: the forge's clone button hands it out. export function parseRepoNameFromRemote(url) { const raw = String(url ?? '').trim(); if (!raw) return null; const path = raw.includes('://') ? raw.split('://')[1] : raw; const segments = path.replace(/\/+$/, '').split(/[/:]/).filter(Boolean); // A bare host is not a repository. Without this, `https://the-forge/` parsed // as a repo named after the host and every class rule matched the wrong thing. if (segments.length < 2) return null; const name = segments.pop().replace(/\.git$/, ''); return name || null; } function repoNameFrom(dir) { try { const remote = execFileSync('git', ['-C', dir, 'remote', 'get-url', 'origin'], { encoding: 'utf8', stdio: ['ignore', 'pipe', 'ignore'], }); const fromRemote = parseRepoNameFromRemote(remote); if (fromRemote) return fromRemote; } catch { /* no remote yet โ€” a repo before its first push is the ordinary case */ } try { return basename(execFileSync('git', ['-C', dir, 'rev-parse', '--show-toplevel'], { encoding: 'utf8' }).trim()); } catch { return basename(dir); } } // The version the package itself claims, from whichever manifest this class uses. function readPackageVersion(dir) { for (const p of ['.claude-plugin/plugin.json', 'package.json', 'pyproject.toml']) { const full = join(dir, p); if (!existsSync(full)) continue; try { const raw = readFileSync(full, 'utf8'); if (p.endsWith('.json')) { const v = JSON.parse(raw).version; if (v) return String(v); } else { const m = /^\s*version\s*=\s*["']([^"']+)["']/m.exec(raw); if (m) return m[1]; } } catch { /* unparseable โ€” try the next one */ } } return null; } export function extractBadgeVersion(readmeText) { const m = /badge\/version-(\d+\.\d+\.\d+)/.exec(readmeText || ''); return m ? m[1] : null; } // Newest released version in the CHANGELOG. `## [Unreleased]` is skipped by // design โ€” it is not a claim that anything shipped. export function extractChangelogTop(changelogText) { for (const line of String(changelogText || '').split('\n')) { const m = /^##\s*\[?v?(\d+\.\d+\.\d+)\]?/.exec(line.trim()); if (m) return m[1]; } return null; } function gitTags(dir) { try { return execFileSync('git', ['-C', dir, 'tag', '--list', 'v*'], { encoding: 'utf8' }) .split('\n').map((s) => s.trim()).filter(Boolean); } catch { return []; } } export function inspectRepo(dir, name, register, description, catalogNames = null) { const tracked = gitFiles(dir); const present = (tracked ?? []).filter((f) => existsSync(join(dir, f))); // Link scanning covers every tracked Markdown file โ€” a dead reference in a // doc is as broken as one in the README. const files = {}; for (const f of (tracked ?? []).filter((p) => p.endsWith('.md'))) { try { files[f] = readFileSync(join(dir, f), 'utf8'); } catch { /* unreadable โ€” skip */ } } if (!files['README.md'] && existsSync(join(dir, 'README.md'))) { files['README.md'] = readFileSync(join(dir, 'README.md'), 'utf8'); } const readme = files['README.md'] ?? ''; let changelog = null; try { changelog = readFileSync(join(dir, 'CHANGELOG.md'), 'utf8'); } catch { /* absent */ } return classifyRepo({ name, files, present, description, pluginVersion: readPackageVersion(dir), readmeBadge: extractBadgeVersion(readme), changelogTop: changelog === null ? null : extractChangelogTop(changelog), tags: gitTags(dir), catalogNames, }, register); } // Grouped by bucket, because that is the order the findings actually get acted // on: what blocks a stranger today, then what is absent, then what merely reads // badly. Severity within a bucket is secondary to that. const BUCKET_TITLE = { broken: 'BROKEN NOW โ€” a stranger is blocked or misled', missing: 'MISSING โ€” an expected artefact is absent', weakening: 'WEAKENING โ€” present, but it reads as amateur', }; function render(result) { const mark = { OK: 'โœ“', WARN: '!', ERROR: 'โœ—', SKIP: 'ยท' }; const klass = result.klass ? ` [${result.klass}]` : ''; const traits = result.traits?.length ? ` {${result.traits.join(', ')}}` : ''; console.log(`\n${mark[result.status]} ${result.name}${klass}${traits} โ€” ${result.status}`); for (const bucket of BUCKETS) { const inBucket = result.findings.filter((f) => f.bucket === bucket); if (!inBucket.length) continue; console.log(`\n ${BUCKET_TITLE[bucket]}`); for (const f of inBucket) console.log(` ${mark[f.level]} ${f.level} ${f.code}: ${f.msg}`); } const skipped = result.findings.filter((f) => f.level === 'SKIP'); if (skipped.length) { console.log('\n NOT CHECKED โ€” these are not passes'); for (const f of skipped) console.log(` ${mark.SKIP} ${f.code}: ${f.msg}`); } const okCount = result.findings.filter((f) => f.level === 'OK').length; console.log(`\n ${mark.OK} ${okCount} check(s) passed`); } async function refresh(register) { const live = await fetchOrgListing(register); const liveNames = new Set(live.map((r) => r.name)); const known = new Set(Object.keys(register.repos ?? {})); const added = [...liveNames].filter((n) => !known.has(n)).sort(); const gone = [...known].filter((n) => !liveNames.has(n)).sort(); console.log(`register: ${known.size} repos ยท forge: ${liveNames.size} repos`); if (added.length) console.log(`\n on the forge, not in the register (add with a class):\n ${added.join('\n ')}`); if (gone.length) console.log(`\n in the register, not on the forge:\n ${gone.join('\n ')}`); if (!added.length && !gone.length) console.log('\n โœ“ register matches the forge'); return added.length + gone.length === 0 ? 0 : 1; } async function main(argv) { const arg = (flag, fallback = null) => { const i = argv.indexOf(flag); return i === -1 ? fallback : argv[i + 1]; }; const register = loadRegister(); if (argv.includes('--refresh')) { process.exit(await refresh(register)); } const dir = arg('--dir', process.cwd()); const name = arg('--name', repoNameFrom(dir)); let description = null; let catalogNames = null; if (!argv.includes('--offline')) { catalogNames = await fetchCatalogNames(register); try { const listing = await fetchOrgListing(register); const row = listing.find((r) => r.name === name); description = row ? (row.description ?? '') : null; } catch { // Unreachable forge leaves description null, which reads as SKIP โ€” never // as a pass. A check that could not run says so. } } const result = inspectRepo(dir, name, register, description, catalogNames); if (argv.includes('--json')) { console.log(JSON.stringify(result, null, 2)); } else { render(result); } process.exit(result.status === 'ERROR' ? 1 : 0); } if (process.argv[1] && process.argv[1].endsWith('repo-standard-check.mjs')) { main(process.argv.slice(2)); }