Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
128 changes: 127 additions & 1 deletion scripts/check-cli-command-ids.mjs
Original file line numberDiff line numberDiff line change
Expand Up@@ -113,6 +113,117 @@ import { fileURLToPath } from 'node:url';
import { execFileSync } from 'node:child_process';
import { isEntrypoint } from './invoked-as.mjs';

// ── The self-test's own battery roster and floor (#13489) ──────────────────
//
// This self-test used to decide success by "no failure was recorded" and
// nothing else, so "every case held" and "the cases never ran" printed the same
// line. Closed the way PR #13487 validated on check-doc-authoring: what is
// pinned is the registered NAMES, not a number. Every section opens with
// `battery('<name>')`, every assertion is attributed to the battery most
// recently opened, and the floor requires the OPENED set to equal the DECLARED
// set with each battery at or above its own count.
//
// ⛔ A pinned TOTAL is not the repair: a battery dropping from 9 cases to 3 keeps
// a total "right" the moment a sibling grows. A set difference says WHICH
// battery stopped; a count says only that something did.
//
// The counts are a FLOOR, not an equality — adding cases is ordinary work and
// must not red. A battery BELOW its floor means cases stopped running; the
// remedy is to find what stopped registering.
//
// The machinery lives HERE, at module scope, rather than inside the self-test:
// this self-test's assertion sink is not a block-bodied helper in its body (it
// is a concise arrow, or a module-scope function), so there is no in-body
// helper to thread a per-run ledger through. Module scope is safe because the
// self-test runs once per process, and it is what lets the existing sink route
// through `registerCase()` with no case rewritten and no assertion changed.
const SELF_TEST_BATTERIES = Object.freeze({
'the id derivation, against a scratch tree (no repo state)': 12,
'a KNOWN-BAD literal: a command id that resolves to nothing': 3,
'the delimiter rule: the six measured noise shapes stay OUT': 6,
'the exemption ledger is site-scoped, not blanket': 3,
'the ledger self-retires: a listed entry that stops reproducing REDS': 3,
'the dispatch-gates declaration (#12016\'s own landing obligation)': 5,
'bin names come from declared data': 3,
'the live repo returns a verdict, and it is green': 4,
});

// DELETING an entry silences that battery's floor exactly as effectively as
// zeroing it, so the roster's own size is pinned too.
const SELF_TEST_BATTERY_FLOOR = 8;

// The key an assertion is filed under when no battery is open. It is not a
// declared battery, so it reds by the same set difference rather than silently
// inflating whichever battery happened to run last.
const UNATTRIBUTED_BATTERY = '(no battery open)';

// ⚠️ None of these helpers is named with a self-test spelling, deliberately and
// on the record: `check:pm-dispatch-gates` anchors on a top-level declaration
// whose NAME spells self-test, and every such name owes a row in that gate's
// COMPOUND_ANCHOR_LEDGER. These are the battery ROSTER's machinery -- they hold
// no fixtures to mask and read no path literal -- so the accurate name is the
// one that says `battery`, not the one that would owe a ledger row for a role
// this code does not have.

/** Cases registered per battery: `battery()` opens one, `registerCase()` files into it. */
const batteryCases = new Map();
let openBattery = null;

/** Open a battery. Every assertion after this line is attributed to it. */
function battery(name) {
openBattery = name;
}

/** Called by the self-test's own assertion sink, once per assertion. */
function registerCase() {
const name = openBattery ?? UNATTRIBUTED_BATTERY;
batteryCases.set(name, (batteryCases.get(name) ?? 0) + 1);
}

/**
* The floor: every declared battery RAN, and ran its cases (#13489).
*
* Evaluated after every battery has had its chance and BEFORE the verdict, so
* the success line can only be printed by a run in which the set of batteries
* that registered assertions EQUALS the set declared.
*/
function batteryFloorFailures() {
const declared = Object.keys(SELF_TEST_BATTERIES);
const problems = [];
if (declared.length < SELF_TEST_BATTERY_FLOOR) {
problems.push(
`SELF_TEST_BATTERIES declares ${declared.length} batteries, below the pinned `
+ `${SELF_TEST_BATTERY_FLOOR} — a battery deleted from the roster takes its own floor with it.`,
);
}
for (const [name, count] of batteryCases) {
if (declared.includes(name)) continue;
problems.push(
`self-test battery "${name}" registered ${count} case(s) but is not declared in `
+ 'SELF_TEST_BATTERIES — an assertion attributed to no declared battery is one nothing floors.',
);
}
for (const name of declared) {
const count = batteryCases.get(name) ?? 0;
if (count >= SELF_TEST_BATTERIES[name]) continue;
problems.push(
count === 0
? `self-test battery "${name}" DID NOT RUN — 0 cases registered, ${SELF_TEST_BATTERIES[name]} pinned. `
+ 'The verdict below would have claimed those cases hold.'
: `self-test battery "${name}" registered ${count} case(s), below its pinned floor of `
+ `${SELF_TEST_BATTERIES[name]} — cases that used to run no longer do.`,
);
}
if (problems.length) {
problems.push(
'A battery at or below its floor means cases STOPPED RUNNING — the battery is the bug, not the '
+ 'number. Find what stopped registering (an early return, a deleted block, a guard that now '
+ 'skips) and restore it.',
);
}
return problems;
}

const REPO_ROOT = join(dirname(fileURLToPath(import.meta.url)), '..');
const OCLIF_COMMANDS_DIR = 'src/commands';

Expand DownExpand Up@@ -453,9 +564,13 @@ let selfTestReachedVerdict = false;

function selfTest() {
const cases = [];
const t = (name, ok, detail = '') => cases.push({ name, ok, detail });
const t = (name, ok, detail = '') => {
registerCase();
return cases.push({ name, ok, detail });
};

// -- the id derivation, against a scratch tree (no repo state) --------------
battery('the id derivation, against a scratch tree (no repo state)');
const dir = mkdtempSync(join(tmpdir(), 'cli-cmd-ids-'));
try {
const cmds = join(dir, 'src', 'commands');
Expand DownExpand Up@@ -499,6 +614,7 @@ function selfTest() {
}

// -- a KNOWN-BAD literal: a command id that resolves to nothing -------------
battery('a KNOWN-BAD literal: a command id that resolves to nothing');
const ids = new Set(['migrate apply', 'migrate', 'build']);
const topics = new Set(['migrate']);
const bad = literalsOn("throw new Error('run \"os migrate nonexistent-command\" first');", ['os']);
Expand All@@ -508,6 +624,7 @@ function selfTest() {
resolveId(literalsOn('`os migrate apply`', ['os'])[0].words, ids, topics) === 'migrate apply');

// -- the delimiter rule: the six measured noise shapes stay OUT ------------
battery('the delimiter rule: the six measured noise shapes stay OUT');
t('Spanish prose ("envios diarios") is not a literal', literalsOn("label: 'Limite de envios diarios',", ['os']).length === 0);
t('a Python import example is not a literal', literalsOn("import os from 'os';", ['os']).length === 0);
t('an unquoted sentence is not a literal', literalsOn('`carry an os validate-clean security posture`,', ['os']).length === 0);
Expand All@@ -516,11 +633,13 @@ function selfTest() {
t('a bin name at a quote IS a literal', literalsOn('via "os migrate apply --allow-destructive".', ['os']).length === 1);

// -- the exemption ledger is site-scoped, not blanket ----------------------
battery('the exemption ledger is site-scoped, not blanket');
t('a declared fixture is exempt', isExempt('scripts/docs-audit/check-drift-comment.mjs', 'os demo'));
t('the SAME text elsewhere is NOT exempt', !isExempt('packages/drivers/driver-sql/src/schema-drift.ts', 'os demo'));
t('a DIFFERENT text in an exempt file is NOT exempt', !isExempt('scripts/docs-audit/check-drift-comment.mjs', 'os migrate gone'));

// -- the ledger self-retires: a listed entry that stops reproducing REDS ---
battery('the ledger self-retires: a listed entry that stops reproducing REDS');
t('every ledger entry reproduces in the live scan', audit().stale.length === 0,
audit().stale.map((e) => `${e.file} "${e.text}"`).join('; '));
t('a fabricated ledger entry would be reported stale',
Expand All@@ -546,6 +665,7 @@ function selfTest() {
// forever and pays itself out as a dev dispatched on a scripts/ card with this gate
// missing from the brief. Both directions are pinned, and both matter — a missing
// declaration is a silent gate, a surplus one is a lying gate.
battery('the dispatch-gates declaration (#12016\'s own landing obligation)');
const separatorless = POPULATION_ROOTS.filter((r) => !r.includes('/'));
t('every whole-root population entry is declared as a subtree (a bare root is refused by '
+ 'hintCovers as too generic, so it needs the `<root>/**` spelling)',
Expand DownExpand Up@@ -588,11 +708,13 @@ function selfTest() {
&& new Set(audit().resolved.filter((x) => x.file.startsWith('scripts/')).map((x) => x.file)).size >= 5);

// -- bin names come from declared data ------------------------------------
battery('bin names come from declared data');
t('oclif.bin is read', binNamesOf({ oclif: { bin: 'os' } }).includes('os'));
t('bin keys join it', binNamesOf({ oclif: { bin: 'os' }, bin: { objectstack: './bin/run.js' } }).includes('objectstack'));
t('a package with no oclif block declares no bins', binNamesOf({ bin: { foo: 'x' } }).length === 0);

// -- the live repo returns a verdict, and it is green ----------------------
battery('the live repo returns a verdict, and it is green');
const live = audit();
t('the live audit returns a verdict', live.refusal === null, live.refusal ?? '');
t('the live repo has at least one CLI package', live.refusal === null && live.clis.length >= 1);
Expand All@@ -602,6 +724,10 @@ function selfTest() {
live.refusal === null && live.resolved.some((x) =>
x.file === 'packages/drivers/driver-sql/src/schema-drift.ts' && x.text === 'os migrate multi-value-columns'));

// The floor runs BEFORE the verdict below, so a success line can only be
// printed by a run in which every declared battery registered its cases.
for (const message of batteryFloorFailures()) cases.push({ name: message, ok: false, detail: '' });

const failed = cases.filter((c) => !c.ok);
for (const c of failed) console.error(` ✗ ${c.name}${c.detail ? ` -- ${c.detail}` : ''}`);
if (failed.length) {
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
128 changes: 127 additions & 1 deletion scripts/check-cli-command-ids.mjs
Original file line numberDiff line numberDiff line change
Expand Up@@ -113,6 +113,117 @@ import { fileURLToPath } from 'node:url';
import { execFileSync } from 'node:child_process';
import { isEntrypoint } from './invoked-as.mjs';

// ── The self-test's own battery roster and floor (#13489) ──────────────────
//
// This self-test used to decide success by "no failure was recorded" and
// nothing else, so "every case held" and "the cases never ran" printed the same
// line. Closed the way PR #13487 validated on check-doc-authoring: what is
// pinned is the registered NAMES, not a number. Every section opens with
// `battery('<name>')`, every assertion is attributed to the battery most
// recently opened, and the floor requires the OPENED set to equal the DECLARED
// set with each battery at or above its own count.
//
// ⛔ A pinned TOTAL is not the repair: a battery dropping from 9 cases to 3 keeps
// a total "right" the moment a sibling grows. A set difference says WHICH
// battery stopped; a count says only that something did.
//
// The counts are a FLOOR, not an equality — adding cases is ordinary work and
// must not red. A battery BELOW its floor means cases stopped running; the
// remedy is to find what stopped registering.
//
// The machinery lives HERE, at module scope, rather than inside the self-test:
// this self-test's assertion sink is not a block-bodied helper in its body (it
// is a concise arrow, or a module-scope function), so there is no in-body
// helper to thread a per-run ledger through. Module scope is safe because the
// self-test runs once per process, and it is what lets the existing sink route
// through `registerCase()` with no case rewritten and no assertion changed.
const SELF_TEST_BATTERIES = Object.freeze({
'the id derivation, against a scratch tree (no repo state)': 12,
'a KNOWN-BAD literal: a command id that resolves to nothing': 3,
'the delimiter rule: the six measured noise shapes stay OUT': 6,
'the exemption ledger is site-scoped, not blanket': 3,
'the ledger self-retires: a listed entry that stops reproducing REDS': 3,
'the dispatch-gates declaration (#12016\'s own landing obligation)': 5,
'bin names come from declared data': 3,
'the live repo returns a verdict, and it is green': 4,
});

// DELETING an entry silences that battery's floor exactly as effectively as
// zeroing it, so the roster's own size is pinned too.
const SELF_TEST_BATTERY_FLOOR = 8;

// The key an assertion is filed under when no battery is open. It is not a
// declared battery, so it reds by the same set difference rather than silently
// inflating whichever battery happened to run last.
const UNATTRIBUTED_BATTERY = '(no battery open)';

// ⚠️ None of these helpers is named with a self-test spelling, deliberately and
// on the record: `check:pm-dispatch-gates` anchors on a top-level declaration
// whose NAME spells self-test, and every such name owes a row in that gate's
// COMPOUND_ANCHOR_LEDGER. These are the battery ROSTER's machinery -- they hold
// no fixtures to mask and read no path literal -- so the accurate name is the
// one that says `battery`, not the one that would owe a ledger row for a role
// this code does not have.

/** Cases registered per battery: `battery()` opens one, `registerCase()` files into it. */
const batteryCases = new Map();
let openBattery = null;

/** Open a battery. Every assertion after this line is attributed to it. */
function battery(name) {
openBattery = name;
}

/** Called by the self-test's own assertion sink, once per assertion. */
function registerCase() {
const name = openBattery ?? UNATTRIBUTED_BATTERY;
batteryCases.set(name, (batteryCases.get(name) ?? 0) + 1);
}

/**
* The floor: every declared battery RAN, and ran its cases (#13489).
*
* Evaluated after every battery has had its chance and BEFORE the verdict, so
* the success line can only be printed by a run in which the set of batteries
* that registered assertions EQUALS the set declared.
*/
function batteryFloorFailures() {
const declared = Object.keys(SELF_TEST_BATTERIES);
const problems = [];
if (declared.length < SELF_TEST_BATTERY_FLOOR) {
problems.push(
`SELF_TEST_BATTERIES declares ${declared.length} batteries, below the pinned `
+ `${SELF_TEST_BATTERY_FLOOR} — a battery deleted from the roster takes its own floor with it.`,
);
}
for (const [name, count] of batteryCases) {
if (declared.includes(name)) continue;
problems.push(
`self-test battery "${name}" registered ${count} case(s) but is not declared in `
+ 'SELF_TEST_BATTERIES — an assertion attributed to no declared battery is one nothing floors.',
);
}
for (const name of declared) {
const count = batteryCases.get(name) ?? 0;
if (count >= SELF_TEST_BATTERIES[name]) continue;
problems.push(
count === 0
? `self-test battery "${name}" DID NOT RUN — 0 cases registered, ${SELF_TEST_BATTERIES[name]} pinned. `
+ 'The verdict below would have claimed those cases hold.'
: `self-test battery "${name}" registered ${count} case(s), below its pinned floor of `
+ `${SELF_TEST_BATTERIES[name]} — cases that used to run no longer do.`,
);
}
if (problems.length) {
problems.push(
'A battery at or below its floor means cases STOPPED RUNNING — the battery is the bug, not the '
+ 'number. Find what stopped registering (an early return, a deleted block, a guard that now '
+ 'skips) and restore it.',
);
}
return problems;
}

const REPO_ROOT = join(dirname(fileURLToPath(import.meta.url)), '..');
const OCLIF_COMMANDS_DIR = 'src/commands';

Expand DownExpand Up@@ -453,9 +564,13 @@ let selfTestReachedVerdict = false;

function selfTest() {
const cases = [];
const t = (name, ok, detail = '') => cases.push({ name, ok, detail });
const t = (name, ok, detail = '') => {
registerCase();
return cases.push({ name, ok, detail });
};

// -- the id derivation, against a scratch tree (no repo state) --------------
battery('the id derivation, against a scratch tree (no repo state)');
const dir = mkdtempSync(join(tmpdir(), 'cli-cmd-ids-'));
try {
const cmds = join(dir, 'src', 'commands');
Expand DownExpand Up@@ -499,6 +614,7 @@ function selfTest() {
}

// -- a KNOWN-BAD literal: a command id that resolves to nothing -------------
battery('a KNOWN-BAD literal: a command id that resolves to nothing');
const ids = new Set(['migrate apply', 'migrate', 'build']);
const topics = new Set(['migrate']);
const bad = literalsOn("throw new Error('run \"os migrate nonexistent-command\" first');", ['os']);
Expand All@@ -508,6 +624,7 @@ function selfTest() {
resolveId(literalsOn('`os migrate apply`', ['os'])[0].words, ids, topics) === 'migrate apply');

// -- the delimiter rule: the six measured noise shapes stay OUT ------------
battery('the delimiter rule: the six measured noise shapes stay OUT');
t('Spanish prose ("envios diarios") is not a literal', literalsOn("label: 'Limite de envios diarios',", ['os']).length === 0);
t('a Python import example is not a literal', literalsOn("import os from 'os';", ['os']).length === 0);
t('an unquoted sentence is not a literal', literalsOn('`carry an os validate-clean security posture`,', ['os']).length === 0);
Expand All@@ -516,11 +633,13 @@ function selfTest() {
t('a bin name at a quote IS a literal', literalsOn('via "os migrate apply --allow-destructive".', ['os']).length === 1);

// -- the exemption ledger is site-scoped, not blanket ----------------------
battery('the exemption ledger is site-scoped, not blanket');
t('a declared fixture is exempt', isExempt('scripts/docs-audit/check-drift-comment.mjs', 'os demo'));
t('the SAME text elsewhere is NOT exempt', !isExempt('packages/drivers/driver-sql/src/schema-drift.ts', 'os demo'));
t('a DIFFERENT text in an exempt file is NOT exempt', !isExempt('scripts/docs-audit/check-drift-comment.mjs', 'os migrate gone'));

// -- the ledger self-retires: a listed entry that stops reproducing REDS ---
battery('the ledger self-retires: a listed entry that stops reproducing REDS');
t('every ledger entry reproduces in the live scan', audit().stale.length === 0,
audit().stale.map((e) => `${e.file} "${e.text}"`).join('; '));
t('a fabricated ledger entry would be reported stale',
Expand All@@ -546,6 +665,7 @@ function selfTest() {
// forever and pays itself out as a dev dispatched on a scripts/ card with this gate
// missing from the brief. Both directions are pinned, and both matter — a missing
// declaration is a silent gate, a surplus one is a lying gate.
battery('the dispatch-gates declaration (#12016\'s own landing obligation)');
const separatorless = POPULATION_ROOTS.filter((r) => !r.includes('/'));
t('every whole-root population entry is declared as a subtree (a bare root is refused by '
+ 'hintCovers as too generic, so it needs the `<root>/**` spelling)',
Expand DownExpand Up@@ -588,11 +708,13 @@ function selfTest() {
&& new Set(audit().resolved.filter((x) => x.file.startsWith('scripts/')).map((x) => x.file)).size >= 5);

// -- bin names come from declared data ------------------------------------
battery('bin names come from declared data');
t('oclif.bin is read', binNamesOf({ oclif: { bin: 'os' } }).includes('os'));
t('bin keys join it', binNamesOf({ oclif: { bin: 'os' }, bin: { objectstack: './bin/run.js' } }).includes('objectstack'));
t('a package with no oclif block declares no bins', binNamesOf({ bin: { foo: 'x' } }).length === 0);

// -- the live repo returns a verdict, and it is green ----------------------
battery('the live repo returns a verdict, and it is green');
const live = audit();
t('the live audit returns a verdict', live.refusal === null, live.refusal ?? '');
t('the live repo has at least one CLI package', live.refusal === null && live.clis.length >= 1);
Expand All@@ -602,6 +724,10 @@ function selfTest() {
live.refusal === null && live.resolved.some((x) =>
x.file === 'packages/drivers/driver-sql/src/schema-drift.ts' && x.text === 'os migrate multi-value-columns'));

// The floor runs BEFORE the verdict below, so a success line can only be
// printed by a run in which every declared battery registered its cases.
for (const message of batteryFloorFailures()) cases.push({ name: message, ok: false, detail: '' });

const failed = cases.filter((c) => !c.ok);
for (const c of failed) console.error(` ✗ ${c.name}${c.detail ? ` -- ${c.detail}` : ''}`);
if (failed.length) {
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
128 changes: 127 additions & 1 deletion scripts/check-cli-command-ids.mjs
Original file line numberDiff line numberDiff line change
Expand Up@@ -113,6 +113,117 @@ import { fileURLToPath } from 'node:url';
import { execFileSync } from 'node:child_process';
import { isEntrypoint } from './invoked-as.mjs';

// ── The self-test's own battery roster and floor (#13489) ──────────────────
//
// This self-test used to decide success by "no failure was recorded" and
// nothing else, so "every case held" and "the cases never ran" printed the same
// line. Closed the way PR #13487 validated on check-doc-authoring: what is
// pinned is the registered NAMES, not a number. Every section opens with
// `battery('<name>')`, every assertion is attributed to the battery most
// recently opened, and the floor requires the OPENED set to equal the DECLARED
// set with each battery at or above its own count.
//
// ⛔ A pinned TOTAL is not the repair: a battery dropping from 9 cases to 3 keeps
// a total "right" the moment a sibling grows. A set difference says WHICH
// battery stopped; a count says only that something did.
//
// The counts are a FLOOR, not an equality — adding cases is ordinary work and
// must not red. A battery BELOW its floor means cases stopped running; the
// remedy is to find what stopped registering.
//
// The machinery lives HERE, at module scope, rather than inside the self-test:
// this self-test's assertion sink is not a block-bodied helper in its body (it
// is a concise arrow, or a module-scope function), so there is no in-body
// helper to thread a per-run ledger through. Module scope is safe because the
// self-test runs once per process, and it is what lets the existing sink route
// through `registerCase()` with no case rewritten and no assertion changed.
const SELF_TEST_BATTERIES = Object.freeze({
'the id derivation, against a scratch tree (no repo state)': 12,
'a KNOWN-BAD literal: a command id that resolves to nothing': 3,
'the delimiter rule: the six measured noise shapes stay OUT': 6,
'the exemption ledger is site-scoped, not blanket': 3,
'the ledger self-retires: a listed entry that stops reproducing REDS': 3,
'the dispatch-gates declaration (#12016\'s own landing obligation)': 5,
'bin names come from declared data': 3,
'the live repo returns a verdict, and it is green': 4,
});

// DELETING an entry silences that battery's floor exactly as effectively as
// zeroing it, so the roster's own size is pinned too.
const SELF_TEST_BATTERY_FLOOR = 8;

// The key an assertion is filed under when no battery is open. It is not a
// declared battery, so it reds by the same set difference rather than silently
// inflating whichever battery happened to run last.
const UNATTRIBUTED_BATTERY = '(no battery open)';

// ⚠️ None of these helpers is named with a self-test spelling, deliberately and
// on the record: `check:pm-dispatch-gates` anchors on a top-level declaration
// whose NAME spells self-test, and every such name owes a row in that gate's
// COMPOUND_ANCHOR_LEDGER. These are the battery ROSTER's machinery -- they hold
// no fixtures to mask and read no path literal -- so the accurate name is the
// one that says `battery`, not the one that would owe a ledger row for a role
// this code does not have.

/** Cases registered per battery: `battery()` opens one, `registerCase()` files into it. */
const batteryCases = new Map();
let openBattery = null;

/** Open a battery. Every assertion after this line is attributed to it. */
function battery(name) {
openBattery = name;
}

/** Called by the self-test's own assertion sink, once per assertion. */
function registerCase() {
const name = openBattery ?? UNATTRIBUTED_BATTERY;
batteryCases.set(name, (batteryCases.get(name) ?? 0) + 1);
}

/**
* The floor: every declared battery RAN, and ran its cases (#13489).
*
* Evaluated after every battery has had its chance and BEFORE the verdict, so
* the success line can only be printed by a run in which the set of batteries
* that registered assertions EQUALS the set declared.
*/
function batteryFloorFailures() {
const declared = Object.keys(SELF_TEST_BATTERIES);
const problems = [];
if (declared.length < SELF_TEST_BATTERY_FLOOR) {
problems.push(
`SELF_TEST_BATTERIES declares ${declared.length} batteries, below the pinned `
+ `${SELF_TEST_BATTERY_FLOOR} — a battery deleted from the roster takes its own floor with it.`,
);
}
for (const [name, count] of batteryCases) {
if (declared.includes(name)) continue;
problems.push(
`self-test battery "${name}" registered ${count} case(s) but is not declared in `
+ 'SELF_TEST_BATTERIES — an assertion attributed to no declared battery is one nothing floors.',
);
}
for (const name of declared) {
const count = batteryCases.get(name) ?? 0;
if (count >= SELF_TEST_BATTERIES[name]) continue;
problems.push(
count === 0
? `self-test battery "${name}" DID NOT RUN — 0 cases registered, ${SELF_TEST_BATTERIES[name]} pinned. `
+ 'The verdict below would have claimed those cases hold.'
: `self-test battery "${name}" registered ${count} case(s), below its pinned floor of `
+ `${SELF_TEST_BATTERIES[name]} — cases that used to run no longer do.`,
);
}
if (problems.length) {
problems.push(
'A battery at or below its floor means cases STOPPED RUNNING — the battery is the bug, not the '
+ 'number. Find what stopped registering (an early return, a deleted block, a guard that now '
+ 'skips) and restore it.',
);
}
return problems;
}

const REPO_ROOT = join(dirname(fileURLToPath(import.meta.url)), '..');
const OCLIF_COMMANDS_DIR = 'src/commands';

Expand DownExpand Up@@ -453,9 +564,13 @@ let selfTestReachedVerdict = false;

function selfTest() {
const cases = [];
const t = (name, ok, detail = '') => cases.push({ name, ok, detail });
const t = (name, ok, detail = '') => {
registerCase();
return cases.push({ name, ok, detail });
};

// -- the id derivation, against a scratch tree (no repo state) --------------
battery('the id derivation, against a scratch tree (no repo state)');
const dir = mkdtempSync(join(tmpdir(), 'cli-cmd-ids-'));
try {
const cmds = join(dir, 'src', 'commands');
Expand DownExpand Up@@ -499,6 +614,7 @@ function selfTest() {
}

// -- a KNOWN-BAD literal: a command id that resolves to nothing -------------
battery('a KNOWN-BAD literal: a command id that resolves to nothing');
const ids = new Set(['migrate apply', 'migrate', 'build']);
const topics = new Set(['migrate']);
const bad = literalsOn("throw new Error('run \"os migrate nonexistent-command\" first');", ['os']);
Expand All@@ -508,6 +624,7 @@ function selfTest() {
resolveId(literalsOn('`os migrate apply`', ['os'])[0].words, ids, topics) === 'migrate apply');

// -- the delimiter rule: the six measured noise shapes stay OUT ------------
battery('the delimiter rule: the six measured noise shapes stay OUT');
t('Spanish prose ("envios diarios") is not a literal', literalsOn("label: 'Limite de envios diarios',", ['os']).length === 0);
t('a Python import example is not a literal', literalsOn("import os from 'os';", ['os']).length === 0);
t('an unquoted sentence is not a literal', literalsOn('`carry an os validate-clean security posture`,', ['os']).length === 0);
Expand All@@ -516,11 +633,13 @@ function selfTest() {
t('a bin name at a quote IS a literal', literalsOn('via "os migrate apply --allow-destructive".', ['os']).length === 1);

// -- the exemption ledger is site-scoped, not blanket ----------------------
battery('the exemption ledger is site-scoped, not blanket');
t('a declared fixture is exempt', isExempt('scripts/docs-audit/check-drift-comment.mjs', 'os demo'));
t('the SAME text elsewhere is NOT exempt', !isExempt('packages/drivers/driver-sql/src/schema-drift.ts', 'os demo'));
t('a DIFFERENT text in an exempt file is NOT exempt', !isExempt('scripts/docs-audit/check-drift-comment.mjs', 'os migrate gone'));

// -- the ledger self-retires: a listed entry that stops reproducing REDS ---
battery('the ledger self-retires: a listed entry that stops reproducing REDS');
t('every ledger entry reproduces in the live scan', audit().stale.length === 0,
audit().stale.map((e) => `${e.file} "${e.text}"`).join('; '));
t('a fabricated ledger entry would be reported stale',
Expand All@@ -546,6 +665,7 @@ function selfTest() {
// forever and pays itself out as a dev dispatched on a scripts/ card with this gate
// missing from the brief. Both directions are pinned, and both matter — a missing
// declaration is a silent gate, a surplus one is a lying gate.
battery('the dispatch-gates declaration (#12016\'s own landing obligation)');
const separatorless = POPULATION_ROOTS.filter((r) => !r.includes('/'));
t('every whole-root population entry is declared as a subtree (a bare root is refused by '
+ 'hintCovers as too generic, so it needs the `<root>/**` spelling)',
Expand DownExpand Up@@ -588,11 +708,13 @@ function selfTest() {
&& new Set(audit().resolved.filter((x) => x.file.startsWith('scripts/')).map((x) => x.file)).size >= 5);

// -- bin names come from declared data ------------------------------------
battery('bin names come from declared data');
t('oclif.bin is read', binNamesOf({ oclif: { bin: 'os' } }).includes('os'));
t('bin keys join it', binNamesOf({ oclif: { bin: 'os' }, bin: { objectstack: './bin/run.js' } }).includes('objectstack'));
t('a package with no oclif block declares no bins', binNamesOf({ bin: { foo: 'x' } }).length === 0);

// -- the live repo returns a verdict, and it is green ----------------------
battery('the live repo returns a verdict, and it is green');
const live = audit();
t('the live audit returns a verdict', live.refusal === null, live.refusal ?? '');
t('the live repo has at least one CLI package', live.refusal === null && live.clis.length >= 1);
Expand All@@ -602,6 +724,10 @@ function selfTest() {
live.refusal === null && live.resolved.some((x) =>
x.file === 'packages/drivers/driver-sql/src/schema-drift.ts' && x.text === 'os migrate multi-value-columns'));

// The floor runs BEFORE the verdict below, so a success line can only be
// printed by a run in which every declared battery registered its cases.
for (const message of batteryFloorFailures()) cases.push({ name: message, ok: false, detail: '' });

const failed = cases.filter((c) => !c.ok);
for (const c of failed) console.error(` ✗ ${c.name}${c.detail ? ` -- ${c.detail}` : ''}`);
if (failed.length) {
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
128 changes: 127 additions & 1 deletion scripts/check-cli-command-ids.mjs
Original file line numberDiff line numberDiff line change
Expand Up@@ -113,6 +113,117 @@ import { fileURLToPath } from 'node:url';
import { execFileSync } from 'node:child_process';
import { isEntrypoint } from './invoked-as.mjs';

// ── The self-test's own battery roster and floor (#13489) ──────────────────
//
// This self-test used to decide success by "no failure was recorded" and
// nothing else, so "every case held" and "the cases never ran" printed the same
// line. Closed the way PR #13487 validated on check-doc-authoring: what is
// pinned is the registered NAMES, not a number. Every section opens with
// `battery('<name>')`, every assertion is attributed to the battery most
// recently opened, and the floor requires the OPENED set to equal the DECLARED
// set with each battery at or above its own count.
//
// ⛔ A pinned TOTAL is not the repair: a battery dropping from 9 cases to 3 keeps
// a total "right" the moment a sibling grows. A set difference says WHICH
// battery stopped; a count says only that something did.
//
// The counts are a FLOOR, not an equality — adding cases is ordinary work and
// must not red. A battery BELOW its floor means cases stopped running; the
// remedy is to find what stopped registering.
//
// The machinery lives HERE, at module scope, rather than inside the self-test:
// this self-test's assertion sink is not a block-bodied helper in its body (it
// is a concise arrow, or a module-scope function), so there is no in-body
// helper to thread a per-run ledger through. Module scope is safe because the
// self-test runs once per process, and it is what lets the existing sink route
// through `registerCase()` with no case rewritten and no assertion changed.
const SELF_TEST_BATTERIES = Object.freeze({
'the id derivation, against a scratch tree (no repo state)': 12,
'a KNOWN-BAD literal: a command id that resolves to nothing': 3,
'the delimiter rule: the six measured noise shapes stay OUT': 6,
'the exemption ledger is site-scoped, not blanket': 3,
'the ledger self-retires: a listed entry that stops reproducing REDS': 3,
'the dispatch-gates declaration (#12016\'s own landing obligation)': 5,
'bin names come from declared data': 3,
'the live repo returns a verdict, and it is green': 4,
});

// DELETING an entry silences that battery's floor exactly as effectively as
// zeroing it, so the roster's own size is pinned too.
const SELF_TEST_BATTERY_FLOOR = 8;

// The key an assertion is filed under when no battery is open. It is not a
// declared battery, so it reds by the same set difference rather than silently
// inflating whichever battery happened to run last.
const UNATTRIBUTED_BATTERY = '(no battery open)';

// ⚠️ None of these helpers is named with a self-test spelling, deliberately and
// on the record: `check:pm-dispatch-gates` anchors on a top-level declaration
// whose NAME spells self-test, and every such name owes a row in that gate's
// COMPOUND_ANCHOR_LEDGER. These are the battery ROSTER's machinery -- they hold
// no fixtures to mask and read no path literal -- so the accurate name is the
// one that says `battery`, not the one that would owe a ledger row for a role
// this code does not have.

/** Cases registered per battery: `battery()` opens one, `registerCase()` files into it. */
const batteryCases = new Map();
let openBattery = null;

/** Open a battery. Every assertion after this line is attributed to it. */
function battery(name) {
openBattery = name;
}

/** Called by the self-test's own assertion sink, once per assertion. */
function registerCase() {
const name = openBattery ?? UNATTRIBUTED_BATTERY;
batteryCases.set(name, (batteryCases.get(name) ?? 0) + 1);
}

/**
* The floor: every declared battery RAN, and ran its cases (#13489).
*
* Evaluated after every battery has had its chance and BEFORE the verdict, so
* the success line can only be printed by a run in which the set of batteries
* that registered assertions EQUALS the set declared.
*/
function batteryFloorFailures() {
const declared = Object.keys(SELF_TEST_BATTERIES);
const problems = [];
if (declared.length < SELF_TEST_BATTERY_FLOOR) {
problems.push(
`SELF_TEST_BATTERIES declares ${declared.length} batteries, below the pinned `
+ `${SELF_TEST_BATTERY_FLOOR} — a battery deleted from the roster takes its own floor with it.`,
);
}
for (const [name, count] of batteryCases) {
if (declared.includes(name)) continue;
problems.push(
`self-test battery "${name}" registered ${count} case(s) but is not declared in `
+ 'SELF_TEST_BATTERIES — an assertion attributed to no declared battery is one nothing floors.',
);
}
for (const name of declared) {
const count = batteryCases.get(name) ?? 0;
if (count >= SELF_TEST_BATTERIES[name]) continue;
problems.push(
count === 0
? `self-test battery "${name}" DID NOT RUN — 0 cases registered, ${SELF_TEST_BATTERIES[name]} pinned. `
+ 'The verdict below would have claimed those cases hold.'
: `self-test battery "${name}" registered ${count} case(s), below its pinned floor of `
+ `${SELF_TEST_BATTERIES[name]} — cases that used to run no longer do.`,
);
}
if (problems.length) {
problems.push(
'A battery at or below its floor means cases STOPPED RUNNING — the battery is the bug, not the '
+ 'number. Find what stopped registering (an early return, a deleted block, a guard that now '
+ 'skips) and restore it.',
);
}
return problems;
}

const REPO_ROOT = join(dirname(fileURLToPath(import.meta.url)), '..');
const OCLIF_COMMANDS_DIR = 'src/commands';

Expand DownExpand Up@@ -453,9 +564,13 @@ let selfTestReachedVerdict = false;

function selfTest() {
const cases = [];
const t = (name, ok, detail = '') => cases.push({ name, ok, detail });
const t = (name, ok, detail = '') => {
registerCase();
return cases.push({ name, ok, detail });
};

// -- the id derivation, against a scratch tree (no repo state) --------------
battery('the id derivation, against a scratch tree (no repo state)');
const dir = mkdtempSync(join(tmpdir(), 'cli-cmd-ids-'));
try {
const cmds = join(dir, 'src', 'commands');
Expand DownExpand Up@@ -499,6 +614,7 @@ function selfTest() {
}

// -- a KNOWN-BAD literal: a command id that resolves to nothing -------------
battery('a KNOWN-BAD literal: a command id that resolves to nothing');
const ids = new Set(['migrate apply', 'migrate', 'build']);
const topics = new Set(['migrate']);
const bad = literalsOn("throw new Error('run \"os migrate nonexistent-command\" first');", ['os']);
Expand All@@ -508,6 +624,7 @@ function selfTest() {
resolveId(literalsOn('`os migrate apply`', ['os'])[0].words, ids, topics) === 'migrate apply');

// -- the delimiter rule: the six measured noise shapes stay OUT ------------
battery('the delimiter rule: the six measured noise shapes stay OUT');
t('Spanish prose ("envios diarios") is not a literal', literalsOn("label: 'Limite de envios diarios',", ['os']).length === 0);
t('a Python import example is not a literal', literalsOn("import os from 'os';", ['os']).length === 0);
t('an unquoted sentence is not a literal', literalsOn('`carry an os validate-clean security posture`,', ['os']).length === 0);
Expand All@@ -516,11 +633,13 @@ function selfTest() {
t('a bin name at a quote IS a literal', literalsOn('via "os migrate apply --allow-destructive".', ['os']).length === 1);

// -- the exemption ledger is site-scoped, not blanket ----------------------
battery('the exemption ledger is site-scoped, not blanket');
t('a declared fixture is exempt', isExempt('scripts/docs-audit/check-drift-comment.mjs', 'os demo'));
t('the SAME text elsewhere is NOT exempt', !isExempt('packages/drivers/driver-sql/src/schema-drift.ts', 'os demo'));
t('a DIFFERENT text in an exempt file is NOT exempt', !isExempt('scripts/docs-audit/check-drift-comment.mjs', 'os migrate gone'));

// -- the ledger self-retires: a listed entry that stops reproducing REDS ---
battery('the ledger self-retires: a listed entry that stops reproducing REDS');
t('every ledger entry reproduces in the live scan', audit().stale.length === 0,
audit().stale.map((e) => `${e.file} "${e.text}"`).join('; '));
t('a fabricated ledger entry would be reported stale',
Expand All@@ -546,6 +665,7 @@ function selfTest() {
// forever and pays itself out as a dev dispatched on a scripts/ card with this gate
// missing from the brief. Both directions are pinned, and both matter — a missing
// declaration is a silent gate, a surplus one is a lying gate.
battery('the dispatch-gates declaration (#12016\'s own landing obligation)');
const separatorless = POPULATION_ROOTS.filter((r) => !r.includes('/'));
t('every whole-root population entry is declared as a subtree (a bare root is refused by '
+ 'hintCovers as too generic, so it needs the `<root>/**` spelling)',
Expand DownExpand Up@@ -588,11 +708,13 @@ function selfTest() {
&& new Set(audit().resolved.filter((x) => x.file.startsWith('scripts/')).map((x) => x.file)).size >= 5);

// -- bin names come from declared data ------------------------------------
battery('bin names come from declared data');
t('oclif.bin is read', binNamesOf({ oclif: { bin: 'os' } }).includes('os'));
t('bin keys join it', binNamesOf({ oclif: { bin: 'os' }, bin: { objectstack: './bin/run.js' } }).includes('objectstack'));
t('a package with no oclif block declares no bins', binNamesOf({ bin: { foo: 'x' } }).length === 0);

// -- the live repo returns a verdict, and it is green ----------------------
battery('the live repo returns a verdict, and it is green');
const live = audit();
t('the live audit returns a verdict', live.refusal === null, live.refusal ?? '');
t('the live repo has at least one CLI package', live.refusal === null && live.clis.length >= 1);
Expand All@@ -602,6 +724,10 @@ function selfTest() {
live.refusal === null && live.resolved.some((x) =>
x.file === 'packages/drivers/driver-sql/src/schema-drift.ts' && x.text === 'os migrate multi-value-columns'));

// The floor runs BEFORE the verdict below, so a success line can only be
// printed by a run in which every declared battery registered its cases.
for (const message of batteryFloorFailures()) cases.push({ name: message, ok: false, detail: '' });

const failed = cases.filter((c) => !c.ok);
for (const c of failed) console.error(` ✗ ${c.name}${c.detail ? ` -- ${c.detail}` : ''}`);
if (failed.length) {
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
128 changes: 127 additions & 1 deletion scripts/check-cli-command-ids.mjs
Original file line numberDiff line numberDiff line change
Expand Up@@ -113,6 +113,117 @@ import { fileURLToPath } from 'node:url';
import { execFileSync } from 'node:child_process';
import { isEntrypoint } from './invoked-as.mjs';

// ── The self-test's own battery roster and floor (#13489) ──────────────────
//
// This self-test used to decide success by "no failure was recorded" and
// nothing else, so "every case held" and "the cases never ran" printed the same
// line. Closed the way PR #13487 validated on check-doc-authoring: what is
// pinned is the registered NAMES, not a number. Every section opens with
// `battery('<name>')`, every assertion is attributed to the battery most
// recently opened, and the floor requires the OPENED set to equal the DECLARED
// set with each battery at or above its own count.
//
// ⛔ A pinned TOTAL is not the repair: a battery dropping from 9 cases to 3 keeps
// a total "right" the moment a sibling grows. A set difference says WHICH
// battery stopped; a count says only that something did.
//
// The counts are a FLOOR, not an equality — adding cases is ordinary work and
// must not red. A battery BELOW its floor means cases stopped running; the
// remedy is to find what stopped registering.
//
// The machinery lives HERE, at module scope, rather than inside the self-test:
// this self-test's assertion sink is not a block-bodied helper in its body (it
// is a concise arrow, or a module-scope function), so there is no in-body
// helper to thread a per-run ledger through. Module scope is safe because the
// self-test runs once per process, and it is what lets the existing sink route
// through `registerCase()` with no case rewritten and no assertion changed.
const SELF_TEST_BATTERIES = Object.freeze({
'the id derivation, against a scratch tree (no repo state)': 12,
'a KNOWN-BAD literal: a command id that resolves to nothing': 3,
'the delimiter rule: the six measured noise shapes stay OUT': 6,
'the exemption ledger is site-scoped, not blanket': 3,
'the ledger self-retires: a listed entry that stops reproducing REDS': 3,
'the dispatch-gates declaration (#12016\'s own landing obligation)': 5,
'bin names come from declared data': 3,
'the live repo returns a verdict, and it is green': 4,
});

// DELETING an entry silences that battery's floor exactly as effectively as
// zeroing it, so the roster's own size is pinned too.
const SELF_TEST_BATTERY_FLOOR = 8;

// The key an assertion is filed under when no battery is open. It is not a
// declared battery, so it reds by the same set difference rather than silently
// inflating whichever battery happened to run last.
const UNATTRIBUTED_BATTERY = '(no battery open)';

// ⚠️ None of these helpers is named with a self-test spelling, deliberately and
// on the record: `check:pm-dispatch-gates` anchors on a top-level declaration
// whose NAME spells self-test, and every such name owes a row in that gate's
// COMPOUND_ANCHOR_LEDGER. These are the battery ROSTER's machinery -- they hold
// no fixtures to mask and read no path literal -- so the accurate name is the
// one that says `battery`, not the one that would owe a ledger row for a role
// this code does not have.

/** Cases registered per battery: `battery()` opens one, `registerCase()` files into it. */
const batteryCases = new Map();
let openBattery = null;

/** Open a battery. Every assertion after this line is attributed to it. */
function battery(name) {
openBattery = name;
}

/** Called by the self-test's own assertion sink, once per assertion. */
function registerCase() {
const name = openBattery ?? UNATTRIBUTED_BATTERY;
batteryCases.set(name, (batteryCases.get(name) ?? 0) + 1);
}

/**
* The floor: every declared battery RAN, and ran its cases (#13489).
*
* Evaluated after every battery has had its chance and BEFORE the verdict, so
* the success line can only be printed by a run in which the set of batteries
* that registered assertions EQUALS the set declared.
*/
function batteryFloorFailures() {
const declared = Object.keys(SELF_TEST_BATTERIES);
const problems = [];
if (declared.length < SELF_TEST_BATTERY_FLOOR) {
problems.push(
`SELF_TEST_BATTERIES declares ${declared.length} batteries, below the pinned `
+ `${SELF_TEST_BATTERY_FLOOR} — a battery deleted from the roster takes its own floor with it.`,
);
}
for (const [name, count] of batteryCases) {
if (declared.includes(name)) continue;
problems.push(
`self-test battery "${name}" registered ${count} case(s) but is not declared in `
+ 'SELF_TEST_BATTERIES — an assertion attributed to no declared battery is one nothing floors.',
);
}
for (const name of declared) {
const count = batteryCases.get(name) ?? 0;
if (count >= SELF_TEST_BATTERIES[name]) continue;
problems.push(
count === 0
? `self-test battery "${name}" DID NOT RUN — 0 cases registered, ${SELF_TEST_BATTERIES[name]} pinned. `
+ 'The verdict below would have claimed those cases hold.'
: `self-test battery "${name}" registered ${count} case(s), below its pinned floor of `
+ `${SELF_TEST_BATTERIES[name]} — cases that used to run no longer do.`,
);
}
if (problems.length) {
problems.push(
'A battery at or below its floor means cases STOPPED RUNNING — the battery is the bug, not the '
+ 'number. Find what stopped registering (an early return, a deleted block, a guard that now '
+ 'skips) and restore it.',
);
}
return problems;
}

const REPO_ROOT = join(dirname(fileURLToPath(import.meta.url)), '..');
const OCLIF_COMMANDS_DIR = 'src/commands';

Expand DownExpand Up@@ -453,9 +564,13 @@ let selfTestReachedVerdict = false;

function selfTest() {
const cases = [];
const t = (name, ok, detail = '') => cases.push({ name, ok, detail });
const t = (name, ok, detail = '') => {
registerCase();
return cases.push({ name, ok, detail });
};

// -- the id derivation, against a scratch tree (no repo state) --------------
battery('the id derivation, against a scratch tree (no repo state)');
const dir = mkdtempSync(join(tmpdir(), 'cli-cmd-ids-'));
try {
const cmds = join(dir, 'src', 'commands');
Expand DownExpand Up@@ -499,6 +614,7 @@ function selfTest() {
}

// -- a KNOWN-BAD literal: a command id that resolves to nothing -------------
battery('a KNOWN-BAD literal: a command id that resolves to nothing');
const ids = new Set(['migrate apply', 'migrate', 'build']);
const topics = new Set(['migrate']);
const bad = literalsOn("throw new Error('run \"os migrate nonexistent-command\" first');", ['os']);
Expand All@@ -508,6 +624,7 @@ function selfTest() {
resolveId(literalsOn('`os migrate apply`', ['os'])[0].words, ids, topics) === 'migrate apply');

// -- the delimiter rule: the six measured noise shapes stay OUT ------------
battery('the delimiter rule: the six measured noise shapes stay OUT');
t('Spanish prose ("envios diarios") is not a literal', literalsOn("label: 'Limite de envios diarios',", ['os']).length === 0);
t('a Python import example is not a literal', literalsOn("import os from 'os';", ['os']).length === 0);
t('an unquoted sentence is not a literal', literalsOn('`carry an os validate-clean security posture`,', ['os']).length === 0);
Expand All@@ -516,11 +633,13 @@ function selfTest() {
t('a bin name at a quote IS a literal', literalsOn('via "os migrate apply --allow-destructive".', ['os']).length === 1);

// -- the exemption ledger is site-scoped, not blanket ----------------------
battery('the exemption ledger is site-scoped, not blanket');
t('a declared fixture is exempt', isExempt('scripts/docs-audit/check-drift-comment.mjs', 'os demo'));
t('the SAME text elsewhere is NOT exempt', !isExempt('packages/drivers/driver-sql/src/schema-drift.ts', 'os demo'));
t('a DIFFERENT text in an exempt file is NOT exempt', !isExempt('scripts/docs-audit/check-drift-comment.mjs', 'os migrate gone'));

// -- the ledger self-retires: a listed entry that stops reproducing REDS ---
battery('the ledger self-retires: a listed entry that stops reproducing REDS');
t('every ledger entry reproduces in the live scan', audit().stale.length === 0,
audit().stale.map((e) => `${e.file} "${e.text}"`).join('; '));
t('a fabricated ledger entry would be reported stale',
Expand All@@ -546,6 +665,7 @@ function selfTest() {
// forever and pays itself out as a dev dispatched on a scripts/ card with this gate
// missing from the brief. Both directions are pinned, and both matter — a missing
// declaration is a silent gate, a surplus one is a lying gate.
battery('the dispatch-gates declaration (#12016\'s own landing obligation)');
const separatorless = POPULATION_ROOTS.filter((r) => !r.includes('/'));
t('every whole-root population entry is declared as a subtree (a bare root is refused by '
+ 'hintCovers as too generic, so it needs the `<root>/**` spelling)',
Expand DownExpand Up@@ -588,11 +708,13 @@ function selfTest() {
&& new Set(audit().resolved.filter((x) => x.file.startsWith('scripts/')).map((x) => x.file)).size >= 5);

// -- bin names come from declared data ------------------------------------
battery('bin names come from declared data');
t('oclif.bin is read', binNamesOf({ oclif: { bin: 'os' } }).includes('os'));
t('bin keys join it', binNamesOf({ oclif: { bin: 'os' }, bin: { objectstack: './bin/run.js' } }).includes('objectstack'));
t('a package with no oclif block declares no bins', binNamesOf({ bin: { foo: 'x' } }).length === 0);

// -- the live repo returns a verdict, and it is green ----------------------
battery('the live repo returns a verdict, and it is green');
const live = audit();
t('the live audit returns a verdict', live.refusal === null, live.refusal ?? '');
t('the live repo has at least one CLI package', live.refusal === null && live.clis.length >= 1);
Expand All@@ -602,6 +724,10 @@ function selfTest() {
live.refusal === null && live.resolved.some((x) =>
x.file === 'packages/drivers/driver-sql/src/schema-drift.ts' && x.text === 'os migrate multi-value-columns'));

// The floor runs BEFORE the verdict below, so a success line can only be
// printed by a run in which every declared battery registered its cases.
for (const message of batteryFloorFailures()) cases.push({ name: message, ok: false, detail: '' });

const failed = cases.filter((c) => !c.ok);
for (const c of failed) console.error(` ✗ ${c.name}${c.detail ? ` -- ${c.detail}` : ''}`);
if (failed.length) {
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
128 changes: 127 additions & 1 deletion scripts/check-cli-command-ids.mjs
Original file line numberDiff line numberDiff line change
Expand Up@@ -113,6 +113,117 @@ import { fileURLToPath } from 'node:url';
import { execFileSync } from 'node:child_process';
import { isEntrypoint } from './invoked-as.mjs';

// ── The self-test's own battery roster and floor (#13489) ──────────────────
//
// This self-test used to decide success by "no failure was recorded" and
// nothing else, so "every case held" and "the cases never ran" printed the same
// line. Closed the way PR #13487 validated on check-doc-authoring: what is
// pinned is the registered NAMES, not a number. Every section opens with
// `battery('<name>')`, every assertion is attributed to the battery most
// recently opened, and the floor requires the OPENED set to equal the DECLARED
// set with each battery at or above its own count.
//
// ⛔ A pinned TOTAL is not the repair: a battery dropping from 9 cases to 3 keeps
// a total "right" the moment a sibling grows. A set difference says WHICH
// battery stopped; a count says only that something did.
//
// The counts are a FLOOR, not an equality — adding cases is ordinary work and
// must not red. A battery BELOW its floor means cases stopped running; the
// remedy is to find what stopped registering.
//
// The machinery lives HERE, at module scope, rather than inside the self-test:
// this self-test's assertion sink is not a block-bodied helper in its body (it
// is a concise arrow, or a module-scope function), so there is no in-body
// helper to thread a per-run ledger through. Module scope is safe because the
// self-test runs once per process, and it is what lets the existing sink route
// through `registerCase()` with no case rewritten and no assertion changed.
const SELF_TEST_BATTERIES = Object.freeze({
'the id derivation, against a scratch tree (no repo state)': 12,
'a KNOWN-BAD literal: a command id that resolves to nothing': 3,
'the delimiter rule: the six measured noise shapes stay OUT': 6,
'the exemption ledger is site-scoped, not blanket': 3,
'the ledger self-retires: a listed entry that stops reproducing REDS': 3,
'the dispatch-gates declaration (#12016\'s own landing obligation)': 5,
'bin names come from declared data': 3,
'the live repo returns a verdict, and it is green': 4,
});

// DELETING an entry silences that battery's floor exactly as effectively as
// zeroing it, so the roster's own size is pinned too.
const SELF_TEST_BATTERY_FLOOR = 8;

// The key an assertion is filed under when no battery is open. It is not a
// declared battery, so it reds by the same set difference rather than silently
// inflating whichever battery happened to run last.
const UNATTRIBUTED_BATTERY = '(no battery open)';

// ⚠️ None of these helpers is named with a self-test spelling, deliberately and
// on the record: `check:pm-dispatch-gates` anchors on a top-level declaration
// whose NAME spells self-test, and every such name owes a row in that gate's
// COMPOUND_ANCHOR_LEDGER. These are the battery ROSTER's machinery -- they hold
// no fixtures to mask and read no path literal -- so the accurate name is the
// one that says `battery`, not the one that would owe a ledger row for a role
// this code does not have.

/** Cases registered per battery: `battery()` opens one, `registerCase()` files into it. */
const batteryCases = new Map();
let openBattery = null;

/** Open a battery. Every assertion after this line is attributed to it. */
function battery(name) {
openBattery = name;
}

/** Called by the self-test's own assertion sink, once per assertion. */
function registerCase() {
const name = openBattery ?? UNATTRIBUTED_BATTERY;
batteryCases.set(name, (batteryCases.get(name) ?? 0) + 1);
}

/**
* The floor: every declared battery RAN, and ran its cases (#13489).
*
* Evaluated after every battery has had its chance and BEFORE the verdict, so
* the success line can only be printed by a run in which the set of batteries
* that registered assertions EQUALS the set declared.
*/
function batteryFloorFailures() {
const declared = Object.keys(SELF_TEST_BATTERIES);
const problems = [];
if (declared.length < SELF_TEST_BATTERY_FLOOR) {
problems.push(
`SELF_TEST_BATTERIES declares ${declared.length} batteries, below the pinned `
+ `${SELF_TEST_BATTERY_FLOOR} — a battery deleted from the roster takes its own floor with it.`,
);
}
for (const [name, count] of batteryCases) {
if (declared.includes(name)) continue;
problems.push(
`self-test battery "${name}" registered ${count} case(s) but is not declared in `
+ 'SELF_TEST_BATTERIES — an assertion attributed to no declared battery is one nothing floors.',
);
}
for (const name of declared) {
const count = batteryCases.get(name) ?? 0;
if (count >= SELF_TEST_BATTERIES[name]) continue;
problems.push(
count === 0
? `self-test battery "${name}" DID NOT RUN — 0 cases registered, ${SELF_TEST_BATTERIES[name]} pinned. `
+ 'The verdict below would have claimed those cases hold.'
: `self-test battery "${name}" registered ${count} case(s), below its pinned floor of `
+ `${SELF_TEST_BATTERIES[name]} — cases that used to run no longer do.`,
);
}
if (problems.length) {
problems.push(
'A battery at or below its floor means cases STOPPED RUNNING — the battery is the bug, not the '
+ 'number. Find what stopped registering (an early return, a deleted block, a guard that now '
+ 'skips) and restore it.',
);
}
return problems;
}

const REPO_ROOT = join(dirname(fileURLToPath(import.meta.url)), '..');
const OCLIF_COMMANDS_DIR = 'src/commands';

Expand DownExpand Up@@ -453,9 +564,13 @@ let selfTestReachedVerdict = false;

function selfTest() {
const cases = [];
const t = (name, ok, detail = '') => cases.push({ name, ok, detail });
const t = (name, ok, detail = '') => {
registerCase();
return cases.push({ name, ok, detail });
};

// -- the id derivation, against a scratch tree (no repo state) --------------
battery('the id derivation, against a scratch tree (no repo state)');
const dir = mkdtempSync(join(tmpdir(), 'cli-cmd-ids-'));
try {
const cmds = join(dir, 'src', 'commands');
Expand DownExpand Up@@ -499,6 +614,7 @@ function selfTest() {
}

// -- a KNOWN-BAD literal: a command id that resolves to nothing -------------
battery('a KNOWN-BAD literal: a command id that resolves to nothing');
const ids = new Set(['migrate apply', 'migrate', 'build']);
const topics = new Set(['migrate']);
const bad = literalsOn("throw new Error('run \"os migrate nonexistent-command\" first');", ['os']);
Expand All@@ -508,6 +624,7 @@ function selfTest() {
resolveId(literalsOn('`os migrate apply`', ['os'])[0].words, ids, topics) === 'migrate apply');

// -- the delimiter rule: the six measured noise shapes stay OUT ------------
battery('the delimiter rule: the six measured noise shapes stay OUT');
t('Spanish prose ("envios diarios") is not a literal', literalsOn("label: 'Limite de envios diarios',", ['os']).length === 0);
t('a Python import example is not a literal', literalsOn("import os from 'os';", ['os']).length === 0);
t('an unquoted sentence is not a literal', literalsOn('`carry an os validate-clean security posture`,', ['os']).length === 0);
Expand All@@ -516,11 +633,13 @@ function selfTest() {
t('a bin name at a quote IS a literal', literalsOn('via "os migrate apply --allow-destructive".', ['os']).length === 1);

// -- the exemption ledger is site-scoped, not blanket ----------------------
battery('the exemption ledger is site-scoped, not blanket');
t('a declared fixture is exempt', isExempt('scripts/docs-audit/check-drift-comment.mjs', 'os demo'));
t('the SAME text elsewhere is NOT exempt', !isExempt('packages/drivers/driver-sql/src/schema-drift.ts', 'os demo'));
t('a DIFFERENT text in an exempt file is NOT exempt', !isExempt('scripts/docs-audit/check-drift-comment.mjs', 'os migrate gone'));

// -- the ledger self-retires: a listed entry that stops reproducing REDS ---
battery('the ledger self-retires: a listed entry that stops reproducing REDS');
t('every ledger entry reproduces in the live scan', audit().stale.length === 0,
audit().stale.map((e) => `${e.file} "${e.text}"`).join('; '));
t('a fabricated ledger entry would be reported stale',
Expand All@@ -546,6 +665,7 @@ function selfTest() {
// forever and pays itself out as a dev dispatched on a scripts/ card with this gate
// missing from the brief. Both directions are pinned, and both matter — a missing
// declaration is a silent gate, a surplus one is a lying gate.
battery('the dispatch-gates declaration (#12016\'s own landing obligation)');
const separatorless = POPULATION_ROOTS.filter((r) => !r.includes('/'));
t('every whole-root population entry is declared as a subtree (a bare root is refused by '
+ 'hintCovers as too generic, so it needs the `<root>/**` spelling)',
Expand DownExpand Up@@ -588,11 +708,13 @@ function selfTest() {
&& new Set(audit().resolved.filter((x) => x.file.startsWith('scripts/')).map((x) => x.file)).size >= 5);

// -- bin names come from declared data ------------------------------------
battery('bin names come from declared data');
t('oclif.bin is read', binNamesOf({ oclif: { bin: 'os' } }).includes('os'));
t('bin keys join it', binNamesOf({ oclif: { bin: 'os' }, bin: { objectstack: './bin/run.js' } }).includes('objectstack'));
t('a package with no oclif block declares no bins', binNamesOf({ bin: { foo: 'x' } }).length === 0);

// -- the live repo returns a verdict, and it is green ----------------------
battery('the live repo returns a verdict, and it is green');
const live = audit();
t('the live audit returns a verdict', live.refusal === null, live.refusal ?? '');
t('the live repo has at least one CLI package', live.refusal === null && live.clis.length >= 1);
Expand All@@ -602,6 +724,10 @@ function selfTest() {
live.refusal === null && live.resolved.some((x) =>
x.file === 'packages/drivers/driver-sql/src/schema-drift.ts' && x.text === 'os migrate multi-value-columns'));

// The floor runs BEFORE the verdict below, so a success line can only be
// printed by a run in which every declared battery registered its cases.
for (const message of batteryFloorFailures()) cases.push({ name: message, ok: false, detail: '' });

const failed = cases.filter((c) => !c.ok);
for (const c of failed) console.error(` ✗ ${c.name}${c.detail ? ` -- ${c.detail}` : ''}`);
if (failed.length) {
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
128 changes: 127 additions & 1 deletion scripts/check-cli-command-ids.mjs
Original file line numberDiff line numberDiff line change
Expand Up@@ -113,6 +113,117 @@ import { fileURLToPath } from 'node:url';
import { execFileSync } from 'node:child_process';
import { isEntrypoint } from './invoked-as.mjs';

// ── The self-test's own battery roster and floor (#13489) ──────────────────
//
// This self-test used to decide success by "no failure was recorded" and
// nothing else, so "every case held" and "the cases never ran" printed the same
// line. Closed the way PR #13487 validated on check-doc-authoring: what is
// pinned is the registered NAMES, not a number. Every section opens with
// `battery('<name>')`, every assertion is attributed to the battery most
// recently opened, and the floor requires the OPENED set to equal the DECLARED
// set with each battery at or above its own count.
//
// ⛔ A pinned TOTAL is not the repair: a battery dropping from 9 cases to 3 keeps
// a total "right" the moment a sibling grows. A set difference says WHICH
// battery stopped; a count says only that something did.
//
// The counts are a FLOOR, not an equality — adding cases is ordinary work and
// must not red. A battery BELOW its floor means cases stopped running; the
// remedy is to find what stopped registering.
//
// The machinery lives HERE, at module scope, rather than inside the self-test:
// this self-test's assertion sink is not a block-bodied helper in its body (it
// is a concise arrow, or a module-scope function), so there is no in-body
// helper to thread a per-run ledger through. Module scope is safe because the
// self-test runs once per process, and it is what lets the existing sink route
// through `registerCase()` with no case rewritten and no assertion changed.
const SELF_TEST_BATTERIES = Object.freeze({
'the id derivation, against a scratch tree (no repo state)': 12,
'a KNOWN-BAD literal: a command id that resolves to nothing': 3,
'the delimiter rule: the six measured noise shapes stay OUT': 6,
'the exemption ledger is site-scoped, not blanket': 3,
'the ledger self-retires: a listed entry that stops reproducing REDS': 3,
'the dispatch-gates declaration (#12016\'s own landing obligation)': 5,
'bin names come from declared data': 3,
'the live repo returns a verdict, and it is green': 4,
});

// DELETING an entry silences that battery's floor exactly as effectively as
// zeroing it, so the roster's own size is pinned too.
const SELF_TEST_BATTERY_FLOOR = 8;

// The key an assertion is filed under when no battery is open. It is not a
// declared battery, so it reds by the same set difference rather than silently
// inflating whichever battery happened to run last.
const UNATTRIBUTED_BATTERY = '(no battery open)';

// ⚠️ None of these helpers is named with a self-test spelling, deliberately and
// on the record: `check:pm-dispatch-gates` anchors on a top-level declaration
// whose NAME spells self-test, and every such name owes a row in that gate's
// COMPOUND_ANCHOR_LEDGER. These are the battery ROSTER's machinery -- they hold
// no fixtures to mask and read no path literal -- so the accurate name is the
// one that says `battery`, not the one that would owe a ledger row for a role
// this code does not have.

/** Cases registered per battery: `battery()` opens one, `registerCase()` files into it. */
const batteryCases = new Map();
let openBattery = null;

/** Open a battery. Every assertion after this line is attributed to it. */
function battery(name) {
openBattery = name;
}

/** Called by the self-test's own assertion sink, once per assertion. */
function registerCase() {
const name = openBattery ?? UNATTRIBUTED_BATTERY;
batteryCases.set(name, (batteryCases.get(name) ?? 0) + 1);
}

/**
* The floor: every declared battery RAN, and ran its cases (#13489).
*
* Evaluated after every battery has had its chance and BEFORE the verdict, so
* the success line can only be printed by a run in which the set of batteries
* that registered assertions EQUALS the set declared.
*/
function batteryFloorFailures() {
const declared = Object.keys(SELF_TEST_BATTERIES);
const problems = [];
if (declared.length < SELF_TEST_BATTERY_FLOOR) {
problems.push(
`SELF_TEST_BATTERIES declares ${declared.length} batteries, below the pinned `
+ `${SELF_TEST_BATTERY_FLOOR} — a battery deleted from the roster takes its own floor with it.`,
);
}
for (const [name, count] of batteryCases) {
if (declared.includes(name)) continue;
problems.push(
`self-test battery "${name}" registered ${count} case(s) but is not declared in `
+ 'SELF_TEST_BATTERIES — an assertion attributed to no declared battery is one nothing floors.',
);
}
for (const name of declared) {
const count = batteryCases.get(name) ?? 0;
if (count >= SELF_TEST_BATTERIES[name]) continue;
problems.push(
count === 0
? `self-test battery "${name}" DID NOT RUN — 0 cases registered, ${SELF_TEST_BATTERIES[name]} pinned. `
+ 'The verdict below would have claimed those cases hold.'
: `self-test battery "${name}" registered ${count} case(s), below its pinned floor of `
+ `${SELF_TEST_BATTERIES[name]} — cases that used to run no longer do.`,
);
}
if (problems.length) {
problems.push(
'A battery at or below its floor means cases STOPPED RUNNING — the battery is the bug, not the '
+ 'number. Find what stopped registering (an early return, a deleted block, a guard that now '
+ 'skips) and restore it.',
);
}
return problems;
}

const REPO_ROOT = join(dirname(fileURLToPath(import.meta.url)), '..');
const OCLIF_COMMANDS_DIR = 'src/commands';

Expand DownExpand Up@@ -453,9 +564,13 @@ let selfTestReachedVerdict = false;

function selfTest() {
const cases = [];
const t = (name, ok, detail = '') => cases.push({ name, ok, detail });
const t = (name, ok, detail = '') => {
registerCase();
return cases.push({ name, ok, detail });
};

// -- the id derivation, against a scratch tree (no repo state) --------------
battery('the id derivation, against a scratch tree (no repo state)');
const dir = mkdtempSync(join(tmpdir(), 'cli-cmd-ids-'));
try {
const cmds = join(dir, 'src', 'commands');
Expand DownExpand Up@@ -499,6 +614,7 @@ function selfTest() {
}

// -- a KNOWN-BAD literal: a command id that resolves to nothing -------------
battery('a KNOWN-BAD literal: a command id that resolves to nothing');
const ids = new Set(['migrate apply', 'migrate', 'build']);
const topics = new Set(['migrate']);
const bad = literalsOn("throw new Error('run \"os migrate nonexistent-command\" first');", ['os']);
Expand All@@ -508,6 +624,7 @@ function selfTest() {
resolveId(literalsOn('`os migrate apply`', ['os'])[0].words, ids, topics) === 'migrate apply');

// -- the delimiter rule: the six measured noise shapes stay OUT ------------
battery('the delimiter rule: the six measured noise shapes stay OUT');
t('Spanish prose ("envios diarios") is not a literal', literalsOn("label: 'Limite de envios diarios',", ['os']).length === 0);
t('a Python import example is not a literal', literalsOn("import os from 'os';", ['os']).length === 0);
t('an unquoted sentence is not a literal', literalsOn('`carry an os validate-clean security posture`,', ['os']).length === 0);
Expand All@@ -516,11 +633,13 @@ function selfTest() {
t('a bin name at a quote IS a literal', literalsOn('via "os migrate apply --allow-destructive".', ['os']).length === 1);

// -- the exemption ledger is site-scoped, not blanket ----------------------
battery('the exemption ledger is site-scoped, not blanket');
t('a declared fixture is exempt', isExempt('scripts/docs-audit/check-drift-comment.mjs', 'os demo'));
t('the SAME text elsewhere is NOT exempt', !isExempt('packages/drivers/driver-sql/src/schema-drift.ts', 'os demo'));
t('a DIFFERENT text in an exempt file is NOT exempt', !isExempt('scripts/docs-audit/check-drift-comment.mjs', 'os migrate gone'));

// -- the ledger self-retires: a listed entry that stops reproducing REDS ---
battery('the ledger self-retires: a listed entry that stops reproducing REDS');
t('every ledger entry reproduces in the live scan', audit().stale.length === 0,
audit().stale.map((e) => `${e.file} "${e.text}"`).join('; '));
t('a fabricated ledger entry would be reported stale',
Expand All@@ -546,6 +665,7 @@ function selfTest() {
// forever and pays itself out as a dev dispatched on a scripts/ card with this gate
// missing from the brief. Both directions are pinned, and both matter — a missing
// declaration is a silent gate, a surplus one is a lying gate.
battery('the dispatch-gates declaration (#12016\'s own landing obligation)');
const separatorless = POPULATION_ROOTS.filter((r) => !r.includes('/'));
t('every whole-root population entry is declared as a subtree (a bare root is refused by '
+ 'hintCovers as too generic, so it needs the `<root>/**` spelling)',
Expand DownExpand Up@@ -588,11 +708,13 @@ function selfTest() {
&& new Set(audit().resolved.filter((x) => x.file.startsWith('scripts/')).map((x) => x.file)).size >= 5);

// -- bin names come from declared data ------------------------------------
battery('bin names come from declared data');
t('oclif.bin is read', binNamesOf({ oclif: { bin: 'os' } }).includes('os'));
t('bin keys join it', binNamesOf({ oclif: { bin: 'os' }, bin: { objectstack: './bin/run.js' } }).includes('objectstack'));
t('a package with no oclif block declares no bins', binNamesOf({ bin: { foo: 'x' } }).length === 0);

// -- the live repo returns a verdict, and it is green ----------------------
battery('the live repo returns a verdict, and it is green');
const live = audit();
t('the live audit returns a verdict', live.refusal === null, live.refusal ?? '');
t('the live repo has at least one CLI package', live.refusal === null && live.clis.length >= 1);
Expand All@@ -602,6 +724,10 @@ function selfTest() {
live.refusal === null && live.resolved.some((x) =>
x.file === 'packages/drivers/driver-sql/src/schema-drift.ts' && x.text === 'os migrate multi-value-columns'));

// The floor runs BEFORE the verdict below, so a success line can only be
// printed by a run in which every declared battery registered its cases.
for (const message of batteryFloorFailures()) cases.push({ name: message, ok: false, detail: '' });

const failed = cases.filter((c) => !c.ok);
for (const c of failed) console.error(` ✗ ${c.name}${c.detail ? ` -- ${c.detail}` : ''}`);
if (failed.length) {
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
128 changes: 127 additions & 1 deletion scripts/check-cli-command-ids.mjs
Original file line numberDiff line numberDiff line change
Expand Up@@ -113,6 +113,117 @@ import { fileURLToPath } from 'node:url';
import { execFileSync } from 'node:child_process';
import { isEntrypoint } from './invoked-as.mjs';

// ── The self-test's own battery roster and floor (#13489) ──────────────────
//
// This self-test used to decide success by "no failure was recorded" and
// nothing else, so "every case held" and "the cases never ran" printed the same
// line. Closed the way PR #13487 validated on check-doc-authoring: what is
// pinned is the registered NAMES, not a number. Every section opens with
// `battery('<name>')`, every assertion is attributed to the battery most
// recently opened, and the floor requires the OPENED set to equal the DECLARED
// set with each battery at or above its own count.
//
// ⛔ A pinned TOTAL is not the repair: a battery dropping from 9 cases to 3 keeps
// a total "right" the moment a sibling grows. A set difference says WHICH
// battery stopped; a count says only that something did.
//
// The counts are a FLOOR, not an equality — adding cases is ordinary work and
// must not red. A battery BELOW its floor means cases stopped running; the
// remedy is to find what stopped registering.
//
// The machinery lives HERE, at module scope, rather than inside the self-test:
// this self-test's assertion sink is not a block-bodied helper in its body (it
// is a concise arrow, or a module-scope function), so there is no in-body
// helper to thread a per-run ledger through. Module scope is safe because the
// self-test runs once per process, and it is what lets the existing sink route
// through `registerCase()` with no case rewritten and no assertion changed.
const SELF_TEST_BATTERIES = Object.freeze({
'the id derivation, against a scratch tree (no repo state)': 12,
'a KNOWN-BAD literal: a command id that resolves to nothing': 3,
'the delimiter rule: the six measured noise shapes stay OUT': 6,
'the exemption ledger is site-scoped, not blanket': 3,
'the ledger self-retires: a listed entry that stops reproducing REDS': 3,
'the dispatch-gates declaration (#12016\'s own landing obligation)': 5,
'bin names come from declared data': 3,
'the live repo returns a verdict, and it is green': 4,
});

// DELETING an entry silences that battery's floor exactly as effectively as
// zeroing it, so the roster's own size is pinned too.
const SELF_TEST_BATTERY_FLOOR = 8;

// The key an assertion is filed under when no battery is open. It is not a
// declared battery, so it reds by the same set difference rather than silently
// inflating whichever battery happened to run last.
const UNATTRIBUTED_BATTERY = '(no battery open)';

// ⚠️ None of these helpers is named with a self-test spelling, deliberately and
// on the record: `check:pm-dispatch-gates` anchors on a top-level declaration
// whose NAME spells self-test, and every such name owes a row in that gate's
// COMPOUND_ANCHOR_LEDGER. These are the battery ROSTER's machinery -- they hold
// no fixtures to mask and read no path literal -- so the accurate name is the
// one that says `battery`, not the one that would owe a ledger row for a role
// this code does not have.

/** Cases registered per battery: `battery()` opens one, `registerCase()` files into it. */
const batteryCases = new Map();
let openBattery = null;

/** Open a battery. Every assertion after this line is attributed to it. */
function battery(name) {
openBattery = name;
}

/** Called by the self-test's own assertion sink, once per assertion. */
function registerCase() {
const name = openBattery ?? UNATTRIBUTED_BATTERY;
batteryCases.set(name, (batteryCases.get(name) ?? 0) + 1);
}

/**
* The floor: every declared battery RAN, and ran its cases (#13489).
*
* Evaluated after every battery has had its chance and BEFORE the verdict, so
* the success line can only be printed by a run in which the set of batteries
* that registered assertions EQUALS the set declared.
*/
function batteryFloorFailures() {
const declared = Object.keys(SELF_TEST_BATTERIES);
const problems = [];
if (declared.length < SELF_TEST_BATTERY_FLOOR) {
problems.push(
`SELF_TEST_BATTERIES declares ${declared.length} batteries, below the pinned `
+ `${SELF_TEST_BATTERY_FLOOR} — a battery deleted from the roster takes its own floor with it.`,
);
}
for (const [name, count] of batteryCases) {
if (declared.includes(name)) continue;
problems.push(
`self-test battery "${name}" registered ${count} case(s) but is not declared in `
+ 'SELF_TEST_BATTERIES — an assertion attributed to no declared battery is one nothing floors.',
);
}
for (const name of declared) {
const count = batteryCases.get(name) ?? 0;
if (count >= SELF_TEST_BATTERIES[name]) continue;
problems.push(
count === 0
? `self-test battery "${name}" DID NOT RUN — 0 cases registered, ${SELF_TEST_BATTERIES[name]} pinned. `
+ 'The verdict below would have claimed those cases hold.'
: `self-test battery "${name}" registered ${count} case(s), below its pinned floor of `
+ `${SELF_TEST_BATTERIES[name]} — cases that used to run no longer do.`,
);
}
if (problems.length) {
problems.push(
'A battery at or below its floor means cases STOPPED RUNNING — the battery is the bug, not the '
+ 'number. Find what stopped registering (an early return, a deleted block, a guard that now '
+ 'skips) and restore it.',
);
}
return problems;
}

const REPO_ROOT = join(dirname(fileURLToPath(import.meta.url)), '..');
const OCLIF_COMMANDS_DIR = 'src/commands';

Expand DownExpand Up@@ -453,9 +564,13 @@ let selfTestReachedVerdict = false;

function selfTest() {
const cases = [];
const t = (name, ok, detail = '') => cases.push({ name, ok, detail });
const t = (name, ok, detail = '') => {
registerCase();
return cases.push({ name, ok, detail });
};

// -- the id derivation, against a scratch tree (no repo state) --------------
battery('the id derivation, against a scratch tree (no repo state)');
const dir = mkdtempSync(join(tmpdir(), 'cli-cmd-ids-'));
try {
const cmds = join(dir, 'src', 'commands');
Expand DownExpand Up@@ -499,6 +614,7 @@ function selfTest() {
}

// -- a KNOWN-BAD literal: a command id that resolves to nothing -------------
battery('a KNOWN-BAD literal: a command id that resolves to nothing');
const ids = new Set(['migrate apply', 'migrate', 'build']);
const topics = new Set(['migrate']);
const bad = literalsOn("throw new Error('run \"os migrate nonexistent-command\" first');", ['os']);
Expand All@@ -508,6 +624,7 @@ function selfTest() {
resolveId(literalsOn('`os migrate apply`', ['os'])[0].words, ids, topics) === 'migrate apply');

// -- the delimiter rule: the six measured noise shapes stay OUT ------------
battery('the delimiter rule: the six measured noise shapes stay OUT');
t('Spanish prose ("envios diarios") is not a literal', literalsOn("label: 'Limite de envios diarios',", ['os']).length === 0);
t('a Python import example is not a literal', literalsOn("import os from 'os';", ['os']).length === 0);
t('an unquoted sentence is not a literal', literalsOn('`carry an os validate-clean security posture`,', ['os']).length === 0);
Expand All@@ -516,11 +633,13 @@ function selfTest() {
t('a bin name at a quote IS a literal', literalsOn('via "os migrate apply --allow-destructive".', ['os']).length === 1);

// -- the exemption ledger is site-scoped, not blanket ----------------------
battery('the exemption ledger is site-scoped, not blanket');
t('a declared fixture is exempt', isExempt('scripts/docs-audit/check-drift-comment.mjs', 'os demo'));
t('the SAME text elsewhere is NOT exempt', !isExempt('packages/drivers/driver-sql/src/schema-drift.ts', 'os demo'));
t('a DIFFERENT text in an exempt file is NOT exempt', !isExempt('scripts/docs-audit/check-drift-comment.mjs', 'os migrate gone'));

// -- the ledger self-retires: a listed entry that stops reproducing REDS ---
battery('the ledger self-retires: a listed entry that stops reproducing REDS');
t('every ledger entry reproduces in the live scan', audit().stale.length === 0,
audit().stale.map((e) => `${e.file} "${e.text}"`).join('; '));
t('a fabricated ledger entry would be reported stale',
Expand All@@ -546,6 +665,7 @@ function selfTest() {
// forever and pays itself out as a dev dispatched on a scripts/ card with this gate
// missing from the brief. Both directions are pinned, and both matter — a missing
// declaration is a silent gate, a surplus one is a lying gate.
battery('the dispatch-gates declaration (#12016\'s own landing obligation)');
const separatorless = POPULATION_ROOTS.filter((r) => !r.includes('/'));
t('every whole-root population entry is declared as a subtree (a bare root is refused by '
+ 'hintCovers as too generic, so it needs the `<root>/**` spelling)',
Expand DownExpand Up@@ -588,11 +708,13 @@ function selfTest() {
&& new Set(audit().resolved.filter((x) => x.file.startsWith('scripts/')).map((x) => x.file)).size >= 5);

// -- bin names come from declared data ------------------------------------
battery('bin names come from declared data');
t('oclif.bin is read', binNamesOf({ oclif: { bin: 'os' } }).includes('os'));
t('bin keys join it', binNamesOf({ oclif: { bin: 'os' }, bin: { objectstack: './bin/run.js' } }).includes('objectstack'));
t('a package with no oclif block declares no bins', binNamesOf({ bin: { foo: 'x' } }).length === 0);

// -- the live repo returns a verdict, and it is green ----------------------
battery('the live repo returns a verdict, and it is green');
const live = audit();
t('the live audit returns a verdict', live.refusal === null, live.refusal ?? '');
t('the live repo has at least one CLI package', live.refusal === null && live.clis.length >= 1);
Expand All@@ -602,6 +724,10 @@ function selfTest() {
live.refusal === null && live.resolved.some((x) =>
x.file === 'packages/drivers/driver-sql/src/schema-drift.ts' && x.text === 'os migrate multi-value-columns'));

// The floor runs BEFORE the verdict below, so a success line can only be
// printed by a run in which every declared battery registered its cases.
for (const message of batteryFloorFailures()) cases.push({ name: message, ok: false, detail: '' });

const failed = cases.filter((c) => !c.ok);
for (const c of failed) console.error(` ✗ ${c.name}${c.detail ? ` -- ${c.detail}` : ''}`);
if (failed.length) {
Expand Down
Loading
Loading