0 Fork 0

Files

T

feat!: one paperspec command with subcommands, help and examples

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>

2026-10-15 09:28:30 -04:00

4.4 KiB

Raw Blame History

22. Conformance

22.1 The suite

Path	Holds	A conforming implementation
`vectors/*.jsonl`	Inputs and expected outputs, one case per line.	Computes every expected output from its input.
`fixtures/packages/`	Valid packages: a converted chemistry paper with corrections, receipts, a multi-level-header table and a dataset; its checks-only export; an open-access paper with two witnesses; a Typst draft; a tiny document, as a folder and as the zip of 12.2.	Accepts each, and recomputes every value it contains.
`fixtures/records/`	A valid record of every other format that is a JSON file of its own; the stage requirements and stamp rules are in `registry/`, and a bundle is built by `paperspec load --bundle`.	Accepts each.
`fixtures/invalid/`	Invalid packages, each with `expect.json` naming the rule it breaks.	Refuses each, and SHOULD name that rule.
`fixtures/keys/`	The test keys that signed the fixtures and the team secret of the checks-only export.	Never uses them for anything else.

All fixture text is synthetic and dedicated to the public domain; license fields inside fixtures describe the fictional works. Each part's CI runs this suite against its own implementation, so the parts cannot drift apart silently.

22.2 Validating a package

A validator checks, in order, and reports each failure as path:line: rule: message:

The manifest: present, valid, sorted, every listed file present with its hash and size, nothing unlisted, paths safe and no symbolic links, required files present.
Every file in canonical form, byte for byte, and every record against its schema.
The tree (3), runs and references between nodes, the counts, and the keys (2.4).
The policy and hashing scheme (12.5).
The five values of every node, the root and meta_hash, when the text is present and the key, if any, is known.
The ID table, the corrections and the history root, the witnesses, pages, locations and references, and every file's order.
Receipts: IDs, roots, documents, node order, signatures against the package's roster, spot-check keys, seeds and samples, and the fidelity distribution.

22.3 Schemas

Schemas use draft 2020-12, restricted to the keywords $schema, $id, $ref, $defs, $comment, title, description, examples, default, deprecated, type, enum, const, properties, required, additionalProperties, patternProperties, propertyNames, minProperties, maxProperties, dependentRequired, items, prefixItems, minItems, maxItems, uniqueItems, contains, minLength, maxLength, pattern, format, minimum, maximum, exclusiveMinimum, exclusiveMaximum, oneOf, anyOf, allOf, not, if, then and else. Patterns avoid \d, \w, \s, \b and lookbehind, whose meaning differs between regular-expression dialects. A schema checks shape; the chapters' rules, such as the five values, are checked by validators.

22.4 Rules

registry/rules.json lists every rule ID with its meaning. Rule IDs are stable: a rule's meaning never changes, and a retired rule's ID is never reused.

Prefix	Covers
`package.`	The manifest, paths, files and schemas.
`doc.tree.`, `doc.node.`, `doc.run.`, `doc.table.`	The tree, node content and runs.
`doc.hash.`	The five values, the root and the metadata hash.
`doc.id.`, `doc.order.`	The ID table and file order.
`doc.policy.`	Text policies and keyed hashing.
`doc.key.`, `doc.counts`, `doc.history`	The keys, the counts and the history root of `document.json`.
`doc.correction.`, `correction.`	A package's corrections, and the gate.
`doc.receipt.`, `doc.qa.`, `doc.fidelity.`	Receipts, spot-checks and levels.
`doc.witness.`, `doc.page.`, `doc.location.`, `doc.reference.`	Witnesses and geometry.
`grade.`	Grading.

22.5 Stability

Within a major version of a format, a valid file stays valid, and every value the chapters define is computed the same way. Rule IDs, enumeration values and format identifiers are never reused with another meaning. A candidate format changes only with a recorded reason and a new or changed vector; a provisional one may change more freely, and says so in registry/formats.json.

4.4 KiB Raw Blame History