alexmandClaude
88379d152c
The six console scripts (paperspec-check, -build, -validate, -load, -stress, -site) become subcommands of a single `paperspec` command: paperspec validate, load, check, build, stress and site. `python -m paperspec COMMAND` runs the same thing. - paperspec/cli/main.py builds the whole parser, apart from the commands, so `paperspec --help` and `paperspec COMMAND --help` work without a checkout or the tools extra; a command's module is imported only when it runs. - `paperspec` with no command prints the overview: what each command does, examples, and which work anywhere (validate, load) and which need a checkout (check, build, stress, site). Each command's help has a description with advice, and worked examples; a misspelled command gets a suggestion (argparse suggest_on_error); `--version` prints the version and the pinned Unicode version. - Each command module exposes run(args) and returns the exit status. Arguments that parse but do not fit together raise UsageError, which prints the command's usage and exits 2: load now also refuses --built-from or --store without --bundle. - The failure messages say what to do: install paperspec[tools], clone the repository, rerun stress with the printed seed, or run paperspec build when the rebuild check differs. check and stress say how many failures they did not list. - check runs the rebuild as `python -m paperspec build`. - pyproject installs one script, `paperspec`; the pixi tasks and the docs use the subcommands. pixi run check passes (run here as `python -m paperspec check` with src/ on the path); the rebuild is byte-identical. pixi.lock still needs `pixi lock`. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
21 lines
1.3 KiB
Markdown
21 lines
1.3 KiB
Markdown
# Fixture sources
|
|
|
|
Each source describes a document as a converter first read it, mistakes included, in a shorthand that `paperspec build` expands.
|
|
The build mints IDs, applies the listed corrections, lays out synthetic geometry, signs the listed receipts and writes the package.
|
|
The shorthand is tooling, not a format.
|
|
|
|
| Shorthand | Becomes |
|
|
| --- | --- |
|
|
| `{"p": [...]}` | A paragraph of the listed sentences. |
|
|
| `{"s": [...]}` | A sentence; a string part is a text run. |
|
|
| `{"sup": t}`, `{"sub": t}`, `{"em": t}` | A styled text run. |
|
|
| `{"m": src}`, `{"t": src}` | A TeX or Typst math run. |
|
|
| `{"cite": [...], "text": t}`, `{"xref": target, "text": t}`, `{"fn": name, "text": t}` | Citation, cross-reference and footnote-mark runs. |
|
|
| `{"eq": {...}}` | A display equation inside the sentence. |
|
|
| `{"row": [...]}`, `{"c": [...]}` | A table row, and a cell with `role`, `rowspan`, `colspan` and `col`. |
|
|
| `"name": "@x"` | A local name, replaced by the minted ID; `ext:<doc>:@x` names a node of another source. |
|
|
| `"page": n` | The page the node and its descendants are laid out on. |
|
|
|
|
`corrections` lists the operations in order, naming nodes by local name; `crop` names the node whose crop is the evidence.
|
|
`anchors_at_rev0` lists the anchors whose resolution `vectors/resolve.jsonl` records, and `receipts` the receipts, spot-checks and revocations to sign.
|