* chore(#2896): convert CONTEXT.md prose defect registry into enforced gates Squashes the prior 4-commit sequence and fixes defects found while resuming this branch: 5 orphaned/corrupted DEFECT fragment lines left by an earlier botched edit, 17 "Source of truth: Memtrace `find_symbol`" placeholders that had destroyed real file-path citations, and 3 DEFECT.GENERATIVE-* entries merged into one RULESET.GENERATIVE-FIX predicate (policy, not an unenforced defect) to satisfy the zero DEFECT.<NAME>.<field>= acceptance criterion. Six mechanizable defects get real gates: DEFECT.UNBOUNDED-SUBPROCESS (eslint-rules/require-subprocess-timeout.cjs), DEFECT.CANARY-VERSION-LEAK (scripts/lint-canary-version-leak.cjs + version-gate.yml), DEFECT.CHANGESET-PR-FIELD-DRIFT (findPrFieldDrift in changeset/lint.cjs), DEFECT.FRONTMATTER-SCALAR-BROAD-GREP, DEFECT.REMOVED-BUT-NEEDED, and DEFECT.DEFAULT-FLIP-DOCUMENTATION (new lint scripts, wired into lint:ci). Already-enforced and unenforceable prose entries are deleted; the gate is the record. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> * chore(#2896): route the new lint tests' subprocess calls through the bounded process-seam helper The 4 new test files for this PR's lint checks called cp.spawnSync/ execFileSync directly with no timeout, tripping this repo's own existing local/no-unbounded-spawn ESLint rule. Route every one through runNode/gitOrThrow (tests/helpers/process-seam.cjs, tests/helpers/git-fixture.cjs) instead, matching the pattern already used elsewhere in the suite (e.g. tests/changeset-lint.test.cjs). Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> * fix: register claude-orchestration.cjs and regenerate stale generated indexes Pre-existing drift on next, unrelated to this PR's own change, surfaced by running lint:ci as part of verifying #2896: two cli_modules (claude-orchestration.cjs, write-set.cjs) landed without a manifest regen, and CONTEXT.md's own edits in this PR staled its two generated indexes. Adds the missing docs/INVENTORY.md row for claude-orchestration.cjs (write-set.cjs already had one — only its manifest entry was stale) and regenerates docs/INVENTORY-MANIFEST.json, docs/CONTEXT-INDEX.json, and examples/dynamic-context-management/CONTEXT-INDEX.json. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> * fix(#2896): default-flip-documentation lint's local fallback base was main, not next Found in review: every other base-ref fallback in this repo (see scripts/changeset/lint.cjs's DEFAULT_BASE, #2988) defaults to `next`, the integration branch every PR actually targets — `main` is the release branch. This script's local fallback (used only when GITHUB_BASE_REF is unset, i.e. never in CI, but potentially on a local or direct invocation) diffed against the wrong ref. No test exercised the unset-env-var path, so it shipped unnoticed; every e2e test sets GITHUB_BASE_REF explicitly and is unaffected by this fix. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> * fix(#2896): stale eslint comment, overclaiming CONTEXT.md wording, and an incompletely-regenerated manifest Found by the isolated Standards code-review pass: - eslint.config.mjs's require-subprocess-timeout comment said "'warn' for now... flip to 'error' once migrated" while the rule already shipped as 'error' with all 8 sites migrated in the same commit — described a state that never existed. - The CONTEXT.md pointer block claimed the rule's bounded call sites "never throw", but roadmap-upgrade.cts's pre-mutation clean-tree check correctly still throws on failure (it gates a destructive real-run migration; degrading to "assume clean" would risk clobbering uncommitted work) — softened the claim to describe both shapes accurately instead of overclaiming one. - docs/INVENTORY-MANIFEST.json's claude-orchestration.cjs/write-set.cjs entries from the prior "fix: register claude-orchestration.cjs..." commit didn't actually land — re-running the generator now includes them; lint:generated-sync is green. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> * chore(#2896): backfill changeset pr field with the real PR number Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> * fix(#2896): normalize buildCorpus file paths to POSIX in lint-removed-but-needed Windows CI caught it: path.relative(root, abs) returns backslash- separated paths on Windows, but findSurvivingReferences's package-lock special case does file.startsWith('.github/workflows') — a forward- slash literal. On Windows the check silently never matched, so tests/removed-but-needed-lint.test.cjs's real-defect-shape fixture got exit 0 instead of the expected exit 1. Normalize at the production source (RULESET.CONTENT-PATH-NORMALIZATION) rather than the test side. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> --------- Co-authored-by: sim <sim@local> Co-authored-by: Claude Sonnet 5 <noreply@anthropic.com>
This commit is contained in:
Tom Boucher
@@ -22,6 +22,7 @@ const LINT_REASON = Object.freeze({
|
||||
OK_NO_USER_FACING_CHANGES: 'ok_no_user_facing_changes',
|
||||
FAIL_MISSING_FRAGMENT: 'fail_missing_fragment',
|
||||
FAIL_INVALID_FRAGMENT: 'fail_invalid_fragment',
|
||||
FAIL_PR_FIELD_DRIFT: 'fail_pr_field_drift',
|
||||
});
|
||||
|
||||
const OPT_OUT_LABEL = 'no-changelog';
|
||||
@@ -53,10 +54,47 @@ function isFragment(file) {
|
||||
return /^\.changeset\/[^/]+\.md$/.test(file) && !file.endsWith('/README.md');
|
||||
}
|
||||
|
||||
function evaluateLint({ changedFiles, labels, fragmentFailures = [] }) {
|
||||
/**
|
||||
* DEFECT.CHANGESET-PR-FIELD-DRIFT (#3316, #3325): a fragment's `pr:` field is
|
||||
* a guess (issue number, stacked-PR leftover) that never got backfilled to
|
||||
* the real PR number after `gh api POST /pulls` returned it.
|
||||
*
|
||||
* Pure: given `prEntries` (`[{ file, pr }]`, one entry per successfully
|
||||
* parsed changed fragment — `pr` is always a positive integer, since
|
||||
* `parseFragment` already rejects `pr: 0` / non-numeric values as
|
||||
* `invalid_pr` before a fragment ever reaches this function) and
|
||||
* `realPrNumber` (the PR this run belongs to, or `null` when unknown —
|
||||
* push/non-PR runs), returns every fragment whose `pr` disagrees with
|
||||
* `realPrNumber`. `realPrNumber == null` always yields `[]`: with no PR
|
||||
* event payload to compare against, there is nothing to drift-check.
|
||||
*
|
||||
* `pr === 0` is always silent regardless of `realPrNumber` — CONTRIBUTING.md
|
||||
* documents `pr: 0` as the deliberate placeholder used "during initial
|
||||
* commit" before `gh api POST /pulls` returns the real number, so it is not
|
||||
* yet a drifted value, just an unbackfilled one. (In practice `parseFragment`
|
||||
* already rejects `pr: 0` as `invalid_pr` before a fragment reaches this
|
||||
* function via `main()`'s wiring — this guard documents and locks in the
|
||||
* pure function's own contract independent of that upstream check.)
|
||||
*/
|
||||
function findPrFieldDrift(prEntries, realPrNumber) {
|
||||
if (realPrNumber == null) return [];
|
||||
const drift = [];
|
||||
for (const { file, pr } of prEntries) {
|
||||
if (pr === 0) continue;
|
||||
if (pr !== realPrNumber) {
|
||||
drift.push({ file, found: pr, expected: realPrNumber });
|
||||
}
|
||||
}
|
||||
return drift;
|
||||
}
|
||||
|
||||
function evaluateLint({ changedFiles, labels, fragmentFailures = [], prFieldDrift = [] }) {
|
||||
if (fragmentFailures.length > 0) {
|
||||
return { ok: false, reason: LINT_REASON.FAIL_INVALID_FRAGMENT, failures: fragmentFailures };
|
||||
}
|
||||
if (prFieldDrift.length > 0) {
|
||||
return { ok: false, reason: LINT_REASON.FAIL_PR_FIELD_DRIFT, drift: prFieldDrift };
|
||||
}
|
||||
if (changedFiles.some(isFragment)) {
|
||||
return { ok: true, reason: LINT_REASON.OK_FRAGMENT_PRESENT };
|
||||
}
|
||||
@@ -78,10 +116,18 @@ function main() {
|
||||
// GitHub Actions event payload path
|
||||
const eventPath = process.env.GITHUB_EVENT_PATH;
|
||||
let labels = [];
|
||||
// DEFECT.CHANGESET-PR-FIELD-DRIFT: the real PR number this run belongs to,
|
||||
// read from the same event payload. `null` on a push / non-PR run (no
|
||||
// `pull_request` in the payload, or no payload at all) — the drift check
|
||||
// below is a no-op in that case, it never fails a push run.
|
||||
let realPrNumber = null;
|
||||
if (eventPath && fs.existsSync(eventPath)) {
|
||||
try {
|
||||
const event = JSON.parse(fs.readFileSync(eventPath, 'utf8'));
|
||||
labels = (event.pull_request?.labels || []).map((l) => l.name);
|
||||
if (event.pull_request && Number.isInteger(event.pull_request.number)) {
|
||||
realPrNumber = event.pull_request.number;
|
||||
}
|
||||
} catch { /* fall through */ }
|
||||
}
|
||||
// #2988: local fallback must match the repo's integration branch (`next`),
|
||||
@@ -107,6 +153,7 @@ function main() {
|
||||
|
||||
// Validate the content of every changed fragment file.
|
||||
const fragmentFailures = [];
|
||||
const prEntries = [];
|
||||
for (const file of changedFiles) {
|
||||
if (!isFragment(file)) continue;
|
||||
// A fragment path in the diff that no longer exists on disk was deleted in
|
||||
@@ -125,10 +172,13 @@ function main() {
|
||||
const result = parseFragment(src);
|
||||
if (!result.ok) {
|
||||
fragmentFailures.push({ file, reason: result.reason, detail: result.detail });
|
||||
continue;
|
||||
}
|
||||
prEntries.push({ file, pr: result.fragment.pr });
|
||||
}
|
||||
|
||||
const verdict = evaluateLint({ changedFiles, labels, fragmentFailures });
|
||||
const prFieldDrift = findPrFieldDrift(prEntries, realPrNumber);
|
||||
const verdict = evaluateLint({ changedFiles, labels, fragmentFailures, prFieldDrift });
|
||||
if (process.argv.includes('--json')) {
|
||||
process.stdout.write(JSON.stringify({ ...verdict, changedFiles, labels }, null, 2) + '\n');
|
||||
} else if (verdict.ok) {
|
||||
@@ -141,6 +191,13 @@ function main() {
|
||||
process.stderr.write(` ${f.file}: ${f.reason}${detail}\n`);
|
||||
}
|
||||
process.stderr.write(`Fix the fragment(s) above before merging.\n`);
|
||||
} else if (verdict.reason === LINT_REASON.FAIL_PR_FIELD_DRIFT) {
|
||||
process.stderr.write(`\nERROR changeset-lint: ${verdict.reason}\n`);
|
||||
process.stderr.write(`The following .changeset fragment(s) have a stale \`pr:\` field (DEFECT.CHANGESET-PR-FIELD-DRIFT):\n`);
|
||||
for (const d of verdict.drift) {
|
||||
process.stderr.write(` ${d.file}: pr: ${d.found}, expected pr: ${d.expected}\n`);
|
||||
}
|
||||
process.stderr.write(`Backfill \`pr:\` with this PR's real number (see .changeset/README.md), then push again.\n`);
|
||||
} else {
|
||||
process.stderr.write(`\nERROR changeset-lint: ${verdict.reason}\n`);
|
||||
process.stderr.write(`PR touches user-facing files but does not include a .changeset/*.md fragment.\n`);
|
||||
@@ -152,4 +209,4 @@ function main() {
|
||||
|
||||
if (require.main === module) runMain(main);
|
||||
|
||||
module.exports = { evaluateLint, LINT_REASON, OPT_OUT_LABEL, isUserFacing, isFragment, DEFAULT_BASE };
|
||||
module.exports = { evaluateLint, LINT_REASON, OPT_OUT_LABEL, isUserFacing, isFragment, DEFAULT_BASE, findPrFieldDrift };
|
||||
|
||||
Reference in New Issue
Block a user