7dd9e59f6b
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>
64 lines
3.0 KiB
JavaScript
64 lines
3.0 KiB
JavaScript
// allow-test-rule: source-text-is-the-product (see #644) — the rendered reference doc's worked-example
|
|
// vocab surface is the runtime contract; this pins its bijection to the source-of-truth fixtures (docs-parity).
|
|
//
|
|
// RED-first parity contract: the portable reference doc (gsd-core/references/prohibition-probe.md) keeps
|
|
// its worked-example JSON blocks in sync with the source-of-truth fixture files under
|
|
// gsd-core/references/prohibition-probe-fixtures/. The fixtures are the canonical data; the doc embeds
|
|
// copies. The comparison is PARSED JSON (deepEqual of JSON.parse on both sides), never a raw-text
|
|
// substring — a reformat that preserves the data does not fail, and any semantic drift does.
|
|
//
|
|
// The reference doc does not exist yet (plan 01-02 creates it and embeds the
|
|
// ```json prohibition-probe:<dir>/<file>``` blocks) — so this is EXPECTED RED now. NOTE for plan 01-02:
|
|
// it MUST embed matching tagged json blocks or this parity test stays red (the doc<->fixture contract).
|
|
'use strict';
|
|
process.env.GSD_TEST_MODE = '1';
|
|
|
|
const { test, describe } = require('node:test');
|
|
const assert = require('node:assert/strict');
|
|
const fs = require('node:fs');
|
|
const path = require('node:path');
|
|
|
|
const docPath = path.join(__dirname, '..', 'gsd-core', 'references', 'prohibition-probe.md');
|
|
const fixturesRoot = path.join(__dirname, '..', 'gsd-core', 'references', 'prohibition-probe-fixtures');
|
|
|
|
// Extract fenced blocks tagged ```json prohibition-probe:<dir>/<file> from the doc, keyed by ref.
|
|
// The \n? before the closing fence allows blocks whose closing fence has no preceding newline.
|
|
function taggedJsonBlocks(md) {
|
|
const re = /```json prohibition-probe:([^\r\n]+)\r?\n([\s\S]*?)\r?\n?```/g;
|
|
const out = {};
|
|
let m;
|
|
while ((m = re.exec(md))) out[m[1].trim()] = m[2];
|
|
return out;
|
|
}
|
|
|
|
describe('prohibition-probe doc/fixture sync', () => {
|
|
test('reference doc exists', () => {
|
|
assert.ok(fs.existsSync(docPath), `${docPath} must exist`);
|
|
});
|
|
|
|
test('doc embeds a tagged fixture block for every expected.json fixture (count-equality)', () => {
|
|
const md = fs.readFileSync(docPath, 'utf8');
|
|
const blocks = taggedJsonBlocks(md);
|
|
const expectedCount = fs.readdirSync(fixturesRoot, { withFileTypes: true })
|
|
.filter(e => e.isDirectory())
|
|
.filter(dir => fs.existsSync(path.join(fixturesRoot, dir.name, 'expected.json')))
|
|
.length;
|
|
assert.strictEqual(
|
|
Object.keys(blocks).length,
|
|
expectedCount,
|
|
`prohibition-probe.md must embed exactly ${expectedCount} tagged blocks (one per fixture expected.json)`
|
|
);
|
|
});
|
|
|
|
test('every tagged doc block parses and deepEquals its fixture file', () => {
|
|
const md = fs.readFileSync(docPath, 'utf8');
|
|
const blocks = taggedJsonBlocks(md);
|
|
for (const [ref, body] of Object.entries(blocks)) {
|
|
const fixtureFile = path.join(fixturesRoot, ref);
|
|
const onDisk = fs.readFileSync(fixtureFile, 'utf8');
|
|
assert.deepEqual(JSON.parse(body), JSON.parse(onDisk),
|
|
`doc block prohibition-probe:${ref} must deepEqual ${fixtureFile}`);
|
|
}
|
|
});
|
|
});
|