docs(CI): the local-checks block is a transcript again - prose moved out of the bash fence #1713

Merged
jaylouisw merged 1 commit from docs/1116-1915 into main 2026-11-16 19:24:00 +00:00
Owner

docs/CI.md → Running the same checks locally.

What was untrue: the ```bash block was not a block of commands. It opened with npm test, then carried the "Two suites are randomised on purpose…" paragraph and its two-item list inside the fence, then closed with the remaining four commands. Copied into a shell, Two suites are randomised on purpose, and both are seeded so a failure reproduces exactly: is executed as a command.

Evidence the prose itself is right (so it was moved, not deleted):

  • test/property-validator.test.js:22-23 — "a seeded PRNG … the seed is printed with every assertion message"; seeds 1..120 at line 105.
  • test/fuzz-importer.test.js:147 — for (let i = 0; i < 400; i++), asserted as "all 400 mutations were checked" at line 194.

Fix: five typeable lines in the fence (npm test, npm run syntax, npm run smoke, docker build -t pf ., npm run audit:ports — all present in package.json scripts), prose after the closing fence.

Guards (before → after, none read CI.md, so identical): syntax-check 356 files OK; control-bytes clean; docs-show-commands 7 passed / 0 failed (51 forms, 102 commands, 60 refusals); help-completeness 8 passed / 0 failed. Fences in CI.md balanced (10 fence lines, 0 unbalanced).

Docs only — no engine change.

`docs/CI.md` → *Running the same checks locally*. **What was untrue:** the ```bash block was not a block of commands. It opened with `npm test`, then carried the "Two suites are randomised on purpose…" paragraph and its two-item list *inside* the fence, then closed with the remaining four commands. Copied into a shell, `Two suites are randomised on purpose, and both are seeded so a failure reproduces exactly:` is executed as a command. **Evidence the prose itself is right** (so it was moved, not deleted): - `test/property-validator.test.js:22-23` — "a seeded PRNG … the seed is printed with every assertion message"; seeds 1..120 at line 105. - `test/fuzz-importer.test.js:147` — `for (let i = 0; i < 400; i++)`, asserted as "all 400 mutations were checked" at line 194. **Fix:** five typeable lines in the fence (`npm test`, `npm run syntax`, `npm run smoke`, `docker build -t pf .`, `npm run audit:ports` — all present in `package.json` scripts), prose after the closing fence. **Guards** (before → after, none read CI.md, so identical): syntax-check 356 files OK; control-bytes clean; docs-show-commands 7 passed / 0 failed (51 forms, 102 commands, 60 refusals); help-completeness 8 passed / 0 failed. Fences in CI.md balanced (10 fence lines, 0 unbalanced). Docs only — no engine change.
docs(CI): the local-checks block is a transcript again - prose moved out of the bash fence
All checks were successful
CI / Classify the change (pull_request) Successful in 14s
PR rebase / Rebase onto main and arm auto-merge (pull_request) Successful in 20s
CI / Server smoke test (pull_request) Successful in 18s
CI / Test (Node 20) (pull_request) Successful in 49s
CI / Test (Node 18) (pull_request) Successful in 54s
CI / Docker build (pull_request) Successful in 29s
CI / Test (Node 22) (pull_request) Successful in 55s
691d07622e
The ```bash block under "Running the same checks locally" opened with `npm test` and then
carried the two-seeded-suites paragraph and its bullet list inside the fence, so the block a
reader copies was five commands with three paragraphs and a list in the middle of them. The
prose is true (test/property-validator.test.js and test/fuzz-importer.test.js are seeded and do
print the seed; the fuzz loop runs exactly 400 mutations, test/fuzz-importer.test.js:147), it
was just in the wrong place: copy the block into a shell and `Two suites are randomised on
purpose` is a command, not a sentence.

The fence now holds the five commands and nothing else; the prose follows it as prose.
jaylouisw scheduled this pull request to auto merge when all checks succeed 2026-11-16 19:23:48 +00:00
jaylouisw force-pushed docs/1116-1915 from 691d07622e
All checks were successful
CI / Classify the change (pull_request) Successful in 14s
PR rebase / Rebase onto main and arm auto-merge (pull_request) Successful in 20s
CI / Server smoke test (pull_request) Successful in 18s
CI / Test (Node 20) (pull_request) Successful in 49s
CI / Test (Node 18) (pull_request) Successful in 54s
CI / Docker build (pull_request) Successful in 29s
CI / Test (Node 22) (pull_request) Successful in 55s
to 1a695f78a1
All checks were successful
CI / Classify the change (pull_request) Successful in 13s
PR rebase / Rebase onto main and arm auto-merge (pull_request) Successful in 14s
CI / Test (Node 18) (pull_request) Has been skipped
CI / Test (Node 20) (pull_request) Has been skipped
CI / Test (Node 22) (pull_request) Has been skipped
CI / Server smoke test (pull_request) Has been skipped
CI / Docker build (pull_request) Has been skipped
2026-11-16 19:23:52 +00:00
Compare
Sign in to join this conversation.
No reviewers
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
jaylouisw/packetforge!1713
No description provided.