Skip to content

Commit 20cecbb

Browse files
claude[bot]claude
andauthored
docs(ci): record the cited-example discipline the mention-shape rationales rely on (#11444)
The "named in a comment rather than read" rationales in this table all reach for `check-nul-bytes.mjs`, and that is load-bearing rather than habit: no test has a reason to READ a gate script, so the claim stays true of it for as long as the sentence exists. The one clause that reached for a different example is the one that rotted -- `sync-template-versions.mjs` was cited that way until #9763 taught the collector to see the split-segment read template-version-stamps.test.ts had been making all along, at which point every sentence naming it went false at once, in copies that had to be retired one at a time. Records the discipline in the table's own JSDoc, next to the sites it governs, and applies it to the one live site that still cited status-changeable examples: @objectstack/plugin-auth cited `serve.ts` and `realtime-protocol.mdx`, both of which are declared mention-only in this same file and can therefore move exactly as sync-template-versions.mjs did. Re-pointed at the invariant example, matching the form the @objectstack/dogfood entry already uses verbatim. Comment text only; no behaviour changes. Claude-Session: https://claude.ai/code/session_015ahemw8RcTgqtxrj15PEZx Co-authored-by: Claude <noreply@anthropic.com>
1 parent e63348c commit 20cecbb

1 file changed

Lines changed: 17 additions & 6 deletions

File tree

scripts/check-cross-package-test-inputs.mjs

Lines changed: 17 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -204,6 +204,17 @@ const REPO_ROOT = resolve(HERE, '..');
204204
* Every entry names the test that justifies it, so the next person can check
205205
* the radius against the code rather than trusting the glob.
206206
*
207+
* A rationale may cite a sibling path as an EXAMPLE only when that path is
208+
* structurally unable to change status. The mention-shape entries below all
209+
* reach for `check-nul-bytes.mjs`, which is load-bearing rather than habit:
210+
* no test has a reason to READ a gate script, so "named rather than read"
211+
* stays true of it for as long as the sentence exists. A path under active
212+
* test does not qualify -- `sync-template-versions.mjs` was cited that way
213+
* until #9763 taught the collector to see the split-segment read that
214+
* `template-version-stamps.test.ts` had been making all along, and every
215+
* sentence naming it went false at once, in copies that had to be retired one
216+
* at a time. Cite the invariant example, or name no sibling at all.
217+
*
207218
* `heldBy` is that sentence made CHECKABLE for the globs the roster cannot see
208219
* (#10566). Most globs are held mechanically: some path the tests name lands
209220
* inside them, and `globHolderVerdict()` finds it. A read whose path this
@@ -546,12 +557,12 @@ export const CROSS_PACKAGE_TEST_INPUTS = {
546557
'packages/runtime/src/**',
547558
'packages/services/service-sms/src/**',
548559
// The three below are NAMED in that test's prose rather than read by it —
549-
// the same shape as `serve.ts` on the @objectstack/spec entry above and
550-
// `realtime-protocol.mdx` on @objectstack/dogfood, and settled the same
551-
// way: the literal collector takes quoted paths without parsing, so a
552-
// mention forces a declaration, and declaring the file is cheaper than
553-
// rewording prose to dodge the scanner. All three are low-churn, so the
554-
// added cache invalidation is nominal next to the two directories above.
560+
// the same shape as `check-nul-bytes.mjs` on the @objectstack/cli entry
561+
// above, and settled the same way: the literal collector takes quoted
562+
// paths without parsing, so a mention forces a declaration, and declaring
563+
// the file is cheaper than rewording prose to dodge the scanner. All
564+
// three are low-churn, so the added cache invalidation is nominal next to
565+
// the two directories above.
555566
'scripts/check-published-files.mjs',
556567
'scripts/check-cross-package-test-inputs.mjs',
557568
'packages/types/src/node-isolation.test.ts',

0 commit comments

Comments
 (0)