cli: remove the torb canon alias, name the formatter rewrite modules for what they are #768

Merged
argus merged 3 commits from loop/751-remove-canon-alias into main 2026-11-13 21:53:04 +00:00
Collaborator

Closes #751

Closes #751
torb canon was the old name of torb format. It now answers like any
unknown command (usage, exit 2). Its rule documentation moves into the
torb format page.

Refs #751
refactor(format): move the canon modules into format/rewrite
Some checks failed
ci / commit messages (pull_request) Successful in 7s
ci / what the change touches (pull_request) Successful in 7s
ci / the VS Code extension (editors/vscode) (pull_request) Has been skipped
pdisc / pdisc (pull_request) Failing after 11s
ci / which runners exist (pull_request) Successful in 1s
ci / bootstrap and conformance (windows-x64) (pull_request) Has been skipped
ci / bootstrap and conformance (linux-arm64) (pull_request) Has been skipped
ci / bootstrap and conformance (macos-arm64) (pull_request) Has been skipped
ci / gates (pull_request) Has been cancelled
ci / tier A (linux-x64) (pull_request) Has been cancelled
ci / tier B (linux-x64) (pull_request) Has been cancelled
ci / tools/release-sync and tools/registry (linux-x64) (pull_request) Has been cancelled
ci / cross-compiled on linux-x64 (windows-x64) (pull_request) Has been cancelled
ci / cross-compiled on linux-x64 (linux-arm64) (pull_request) Has been cancelled
ci / cross-compiled on linux-x64 (macos-arm64) (pull_request) Has been cancelled
ci / every host emits the same C (pull_request) Has been cancelled
ci / the playground (torb as WebAssembly) (pull_request) Has been cancelled
ci / conformance (JavaScript under Node.js) (pull_request) Has been cancelled
ci / conformance (PHP 5.6, 7.4 and 8.4) (pull_request) Has been cancelled
ci / pack the seed (pull_request) Has been cancelled
ci / archives (pull_request) Has been cancelled
ci / bootstrap (linux-x64) (pull_request) Has been cancelled
e590f2cd57
compiler/src/canon/ held the rewrite rules of torb format under the name
of a command that no longer exists. They live next to the formatter that
uses them; every import is updated, no behaviour changes.

Refs #751
orion force-pushed loop/751-remove-canon-alias from e590f2cd57
Some checks failed
ci / commit messages (pull_request) Successful in 7s
ci / what the change touches (pull_request) Successful in 7s
ci / the VS Code extension (editors/vscode) (pull_request) Has been skipped
pdisc / pdisc (pull_request) Failing after 11s
ci / which runners exist (pull_request) Successful in 1s
ci / bootstrap and conformance (windows-x64) (pull_request) Has been skipped
ci / bootstrap and conformance (linux-arm64) (pull_request) Has been skipped
ci / bootstrap and conformance (macos-arm64) (pull_request) Has been skipped
ci / gates (pull_request) Has been cancelled
ci / tier A (linux-x64) (pull_request) Has been cancelled
ci / tier B (linux-x64) (pull_request) Has been cancelled
ci / tools/release-sync and tools/registry (linux-x64) (pull_request) Has been cancelled
ci / cross-compiled on linux-x64 (windows-x64) (pull_request) Has been cancelled
ci / cross-compiled on linux-x64 (linux-arm64) (pull_request) Has been cancelled
ci / cross-compiled on linux-x64 (macos-arm64) (pull_request) Has been cancelled
ci / every host emits the same C (pull_request) Has been cancelled
ci / the playground (torb as WebAssembly) (pull_request) Has been cancelled
ci / conformance (JavaScript under Node.js) (pull_request) Has been cancelled
ci / conformance (PHP 5.6, 7.4 and 8.4) (pull_request) Has been cancelled
ci / pack the seed (pull_request) Has been cancelled
ci / archives (pull_request) Has been cancelled
ci / bootstrap (linux-x64) (pull_request) Has been cancelled
to 3fd8c3738d
All checks were successful
ci / commit messages (pull_request) Successful in 6s
ci / what the change touches (pull_request) Successful in 6s
ci / the VS Code extension (editors/vscode) (pull_request) Has been skipped
pdisc / pdisc (pull_request) Successful in 12s
ci / which runners exist (pull_request) Successful in 2s
ci / bootstrap and conformance (macos-arm64) (pull_request) Has been skipped
ci / bootstrap and conformance (windows-x64) (pull_request) Has been skipped
ci / bootstrap and conformance (linux-arm64) (pull_request) Has been skipped
ci / bootstrap (linux-x64) (pull_request) Successful in 11m17s
ci / cross-compiled on linux-x64 (windows-x64) (pull_request) Has been skipped
ci / cross-compiled on linux-x64 (linux-arm64) (pull_request) Has been skipped
ci / cross-compiled on linux-x64 (macos-arm64) (pull_request) Has been skipped
ci / tools/release-sync and tools/registry (linux-x64) (pull_request) Successful in 4m24s
ci / every host emits the same C (pull_request) Successful in 9m40s
ci / tier B (linux-x64) (pull_request) Successful in 27m37s
ci / the playground (torb as WebAssembly) (pull_request) Successful in 4m17s
ci / conformance (JavaScript under Node.js) (pull_request) Successful in 2m3s
ci / conformance (PHP 5.6, 7.4 and 8.4) (pull_request) Successful in 4m32s
ci / tier A (linux-x64) (pull_request) Successful in 44m33s
ci / pack the seed (pull_request) Has been skipped
ci / archives (pull_request) Has been skipped
ci / gates (pull_request) Successful in 0s
2026-11-13 20:14:03 +00:00
Compare
argus approved these changes 2026-11-13 21:53:01 +00:00
argus left a comment

Approved at head 3fd8c37 (task: #751, Closes #751; scope matches its acceptance criteria).

  • Tests/CI: ok. Combined status success on this head (tier A/B, fixpoint, conformance, pdisc, gates; skipped jobs are the path-filtered ones). formatOptionsOfCanon and its test are removed together; the CLI regression check (tools/command-line.sh, tests/command-line/arguments.expected) pins torb canon -> usage on stderr, names torb format, never mentions canon, exit 2.
  • Correctness: ok. The canon match arm, the "canon" usage alias and the format | canon help route are gone, so torb canon falls through to the generic _ arm (usage, exit 2). The eight canon/* modules are pure renames to format/rewrite/ (similarity 96-100%; only ../ import depth and one removed history paragraph changed); all importers (format/*, language-server/*, documentation/panics.trb, tests) are updated. No leftover src/canon reference in the tree.
  • Scope: ok. Alias removal, page deletion, module move, ROADMAP line, rule docs folded into torb-format.md; nothing beyond #751.
  • Security/data/placement/architecture: ok. No secrets, no new dependency or boundary beyond the module path; no data or storage format touched.
  • Docs: ok. torb-canon.md deleted in docs/ and in the skill copy, indexes/inventory/README tree/ROADMAP updated, sidecar restamped, pdisc green.

Non-blocking:

  1. docs/design/* (WEB, RELEASE, COLLECTIONS, URI, PROJECT, COLLECTION-STORAGE), docs/TYPECHECKER.md:1931, docs/RUST-EXIT.md:39-40,360 and the audit report still name torb canon. They are historical records, so I read "no page mentions the command" as the user-facing pages; a follow-up sweep is optional.
  2. Sentence case: compiler/src/documentation/canon.trb:552 ("... the former canon command (the reference) ...") and compiler/tests/documentation.test.trb:681 ("... the formatter restricts ...") now start a sentence in lowercase after a period.
  3. docs/tooling/torb-format.md (and the skill copy): the intro line and the "Rewriting, never generating" paragraph exceed the usual 120-column wrap; the "layout of the whole line" wording there reads oddly.
Approved at head 3fd8c37 (task: #751, Closes #751; scope matches its acceptance criteria). - **Tests/CI:** ok. Combined status success on this head (tier A/B, fixpoint, conformance, pdisc, gates; skipped jobs are the path-filtered ones). `formatOptionsOfCanon` and its test are removed together; the CLI regression check (`tools/command-line.sh`, `tests/command-line/arguments.expected`) pins `torb canon` -> usage on stderr, names `torb format`, never mentions `canon`, exit 2. - **Correctness:** ok. The `canon` match arm, the `"canon"` usage alias and the `format | canon` help route are gone, so `torb canon` falls through to the generic `_` arm (usage, exit 2). The eight `canon/*` modules are pure renames to `format/rewrite/` (similarity 96-100%; only `../` import depth and one removed history paragraph changed); all importers (`format/*`, `language-server/*`, `documentation/panics.trb`, tests) are updated. No leftover `src/canon` reference in the tree. - **Scope:** ok. Alias removal, page deletion, module move, ROADMAP line, rule docs folded into `torb-format.md`; nothing beyond #751. - **Security/data/placement/architecture:** ok. No secrets, no new dependency or boundary beyond the module path; no data or storage format touched. - **Docs:** ok. `torb-canon.md` deleted in `docs/` and in the skill copy, indexes/inventory/README tree/ROADMAP updated, sidecar restamped, pdisc green. Non-blocking: 1. `docs/design/*` (WEB, RELEASE, COLLECTIONS, URI, PROJECT, COLLECTION-STORAGE), `docs/TYPECHECKER.md:1931`, `docs/RUST-EXIT.md:39-40,360` and the audit report still name `torb canon`. They are historical records, so I read "no page mentions the command" as the user-facing pages; a follow-up sweep is optional. 2. Sentence case: `compiler/src/documentation/canon.trb:552` ("... the former canon command (the reference) ...") and `compiler/tests/documentation.test.trb:681` ("... the formatter restricts ...") now start a sentence in lowercase after a period. 3. `docs/tooling/torb-format.md` (and the skill copy): the intro line and the "Rewriting, never generating" paragraph exceed the usual 120-column wrap; the "layout of the whole line" wording there reads oddly.
argus merged commit f4bbbdc918 into main 2026-11-13 21:53:04 +00:00
argus deleted branch loop/751-remove-canon-alias 2026-11-13 21:53:04 +00:00
Sign in to join this conversation.
No reviewers
No milestone
No project
No assignees
2 participants
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
torbscript/language!768
No description provided.