docs(CLI): the help-coverage guard types 102 rows, not the 100 the page quotes #1875

Merged
jaylouisw merged 1 commit from docs/1117-1716 into main 2026-11-17 17:23:02 +00:00
Owner

What was untrue

docs/CLI.md, section help is an index, and a test reads it out of the parser, said the hand-written list in test/help-completeness.test.js holds 100 rows: "Every row in it is typed at a real device and must be accepted - 100 of them now".

The list holds 102. The count was last set in d00d312c (98 -> 100) when lease infinite split the pool row (#1776). Since then 79a6cc94 (#1869) added two rows - ['ip routing', 'config', ROUTER] and ['no ip routing', 'config', ROUTER] - and the guard has printed 102 ever since.

Evidence from the code

  • node test/help-completeness.test.js prints 102 advertised commands are all accepted, where the number is advertised.length (test/help-completeness.test.js:288).
  • Counting ^\s*\[ rows inside the const advertised = [...] literal gives 102, the two ip routing rows included.
  • engine/cli.js:563 carries the verb ({ modes: ['config'], match: ['ip', 'routing'], syntax: 'no ip routing', ... }) and engine/cli.js:6042 lists it in help, so the rows are real commands, not doc rows ahead of the parser.

What changed

One sentence: 100 to 102, with the two rows named and their PR (#1869), plus a clause saying the number is a reading because the guard prints it.

Guards (before / after)

  • node scripts/syntax-check.js - 391 files OK / 391 files OK
  • node scripts/check-control-bytes.js - clean / clean
  • docs-commands (test/docs-show-commands.test.js) - 7 passed / 7 passed (54 forms, 108 commands, 66 refusals)
  • docs-syntax (test/docs-cli-transcript.test.js) - 4 passed / 4 passed
  • help-coverage (test/help-completeness.test.js) - 8 passed / 8 passed (102 advertised rows typed)
  • help-forms neighbours unchanged and green: show-argument-refusal 77, no-form-help-key 81, command-word-abbreviation 128

Docs-only diff; no engine or test file touched.

## What was untrue `docs/CLI.md`, section *`help` is an index, and a test reads it out of the parser*, said the hand-written list in `test/help-completeness.test.js` holds **100 rows**: "Every row in it is typed at a real device and must be accepted - 100 of them now". The list holds 102. The count was last set in d00d312c (98 -> 100) when `lease infinite` split the pool row (#1776). Since then 79a6cc94 (#1869) added two rows - `['ip routing', 'config', ROUTER]` and `['no ip routing', 'config', ROUTER]` - and the guard has printed 102 ever since. ## Evidence from the code - `node test/help-completeness.test.js` prints `102 advertised commands are all accepted`, where the number is `advertised.length` (test/help-completeness.test.js:288). - Counting `^\s*\[` rows inside the `const advertised = [...]` literal gives 102, the two `ip routing` rows included. - `engine/cli.js:563` carries the verb (`{ modes: ['config'], match: ['ip', 'routing'], syntax: 'no ip routing', ... }`) and `engine/cli.js:6042` lists it in `help`, so the rows are real commands, not doc rows ahead of the parser. ## What changed One sentence: 100 to 102, with the two rows named and their PR (#1869), plus a clause saying the number is a reading because the guard prints it. ## Guards (before / after) - `node scripts/syntax-check.js` - 391 files OK / 391 files OK - `node scripts/check-control-bytes.js` - clean / clean - docs-commands (`test/docs-show-commands.test.js`) - 7 passed / 7 passed (54 forms, 108 commands, 66 refusals) - docs-syntax (`test/docs-cli-transcript.test.js`) - 4 passed / 4 passed - help-coverage (`test/help-completeness.test.js`) - 8 passed / 8 passed (102 advertised rows typed) - help-forms neighbours unchanged and green: show-argument-refusal 77, no-form-help-key 81, command-word-abbreviation 128 Docs-only diff; no engine or test file touched.
docs(CLI): the help-coverage guard types 102 rows, not the 100 the page quotes
All checks were successful
CI / Classify the change (pull_request) Successful in 9s
PR rebase / Rebase onto main and arm auto-merge (pull_request) Successful in 16s
CI / Server smoke test (pull_request) Successful in 11s
CI / Test (Node 20) (pull_request) Successful in 47s
CI / Test (Node 18) (pull_request) Successful in 53s
CI / Test (Node 22) (pull_request) Successful in 52s
CI / Docker build (pull_request) Successful in 26s
CI / Arm auto-merge (pull_request) Successful in 7s
a2b4d21e90
The page counted the hand-written rows test/help-completeness.test.js types
at a real device, last set to 100 when `lease infinite` split the pool row
(#1776). Two rows have been added since: `ip routing` and `no ip routing`
(#1869), against the same guard. The guard prints the count it typed -
`102 advertised commands are all accepted` - so the sentence now reads 102
and names where the last two came from.
jaylouisw force-pushed docs/1117-1716 from a2b4d21e90
All checks were successful
CI / Classify the change (pull_request) Successful in 9s
PR rebase / Rebase onto main and arm auto-merge (pull_request) Successful in 16s
CI / Server smoke test (pull_request) Successful in 11s
CI / Test (Node 20) (pull_request) Successful in 47s
CI / Test (Node 18) (pull_request) Successful in 53s
CI / Test (Node 22) (pull_request) Successful in 52s
CI / Docker build (pull_request) Successful in 26s
CI / Arm auto-merge (pull_request) Successful in 7s
to 21b321d4b4
All checks were successful
CI / Classify the change (pull_request) Successful in 10s
PR rebase / Rebase onto main and arm auto-merge (pull_request) Successful in 10s
CI / Server smoke test (pull_request) Has been skipped
CI / Docker build (pull_request) Has been skipped
CI / Test (Node 20) (pull_request) Successful in 48s
CI / Test (Node 22) (pull_request) Successful in 51s
CI / Test (Node 18) (pull_request) Successful in 55s
CI / Arm auto-merge (pull_request) Successful in 18s
2026-11-17 17:20:55 +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!1875
No description provided.