reportist/README.md

1.1 KiB

Reportist

Reportist validates and renders structured YAML or JSON reports with Typst. It has no dependency on the Beffroi integration repository or any specific plugin.

Render a report

./render.sh examples/example-report.yaml --output report.pdf

Render through a plugin

./render-plugin.sh /path/to/plugin /path/to/input output.pdf [plugin options]

A plugin directory contains plugin.json (name, version, input, output) and an executable prepare.sh. Reportist invokes prepare.sh INPUT STAGE REPORTIST_ROOT [plugin options]. The plugin writes a validated Reportist v1 report.json and any relative assets into STAGE. Reportist then uses its normal renderer and schema validation. Plugins own domain interpretation; Reportist owns document presentation. Plugins can be kept in any repository.

Batch and validation

bash tools/render-all.sh /path/to/reports --output-dir /path/to/pdfs
bash tools/validate.sh examples/example-report.yaml
bash tools/validate-all.sh /path/to/reports

See docs/report-contract.md and docs/development.md.