An allow-test-rule annotation citing a category that does not apply is worse than no annotation, because it reads as reviewed. Eight were confirmed by reading the assertions each one covered, and auditing the rest found five more plus one refutation — a converter test whose wording described the wrong mechanism while the covered assertion genuinely was deployed-text. The instructive one used the CANONICAL string for the same mistake: STATE.md command output labelled as a deployed artifact. A canonical string is not evidence the category fits, which is why normalising strings alone would have laundered the problem rather than fixed it. Every mapping the audit had inferred rather than code-verified was spot-checked before rewriting, and the ones that turned out not to fit were re-annotated rather than relabelled. Fourteen STATE.md assertions had a typed extractor available all along and now use it; their annotations came out because nothing needs exempting. Eight assertions genuinely need a production change first — CLI stdout and stderr with no structured mode — and are tagged pending-migration-to-typed-ir citing #3090, which is what that category is for. It had zero real uses before this, while one file carried a real citation to migration issue #2974 under a non-canonical tag. Six annotations covered assertions that do no text matching at all. An exemption for a violation that does not exist is noise that makes the real ones harder to audit; those are removed. atomic-write-coverage gains the annotation it always warranted — its own docstring describes a structural-regression-guard while the file carried none. Fifty-nine non-canonical strings across roughly thirty files are normalised, and the allow-test-rule allowlist is regenerated to match. 472 annotations became 463: every one now uses a canonical category, and the two remaining non-canonical strings are ESLint RuleTester fixtures, not annotations. Refs #3057 Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
34 lines
1.3 KiB
JavaScript
34 lines
1.3 KiB
JavaScript
// allow-test-rule: source-text-is-the-product — INVENTORY.md heading format is the shipped doc surface being locked
|
|
'use strict';
|
|
|
|
/**
|
|
* Guards that docs/INVENTORY.md does NOT contain "(N shipped)" count
|
|
* scalars in section headings. Hard counts in shared-line headings cause
|
|
* silent undercount when two branches each add a module (DEFECT.INVENTORY-MERGE-UNDERCOUNT).
|
|
*
|
|
* Regression-must-fail-first: run this BEFORE removing the counts to confirm
|
|
* it catches the bad heading format, then after removal to confirm it passes.
|
|
*/
|
|
|
|
const { test } = require('node:test');
|
|
const assert = require('node:assert/strict');
|
|
const fs = require('node:fs');
|
|
const path = require('node:path');
|
|
|
|
const ROOT = path.resolve(__dirname, '..');
|
|
const INVENTORY_PATH = path.join(ROOT, 'docs', 'INVENTORY.md');
|
|
|
|
test('docs/INVENTORY.md has no "(N shipped)" count scalars in headings', () => {
|
|
const content = fs.readFileSync(INVENTORY_PATH, 'utf8');
|
|
const offenders = content
|
|
.split(/\r?\n/)
|
|
.filter((line) => /^##\s+.+\(\d+\s+shipped\)/.test(line));
|
|
|
|
assert.ok(
|
|
offenders.length === 0,
|
|
'docs/INVENTORY.md still has hard-count headings (DEFECT.INVENTORY-MERGE-UNDERCOUNT).\n' +
|
|
'Remove the "(N shipped)" parenthetical from each:\n' +
|
|
offenders.map((l) => ' ' + l).join('\n'),
|
|
);
|
|
});
|