Generic Typst-based report renderer. Turns structured YAML/JSON reports into sober, reproducible PDF documents.
Go to file
Dandaedre 493af046ae
Avoid nonportable sorting in report validation batch
2026-09-16 21:04:40 +02:00
docs Own report and diagnostic plugins behind one build CLI 2026-09-16 21:03:17 +02:00
examples Separate report renderer and share visual elements 2026-09-16 20:08:11 +02:00
plugins Own report and diagnostic plugins behind one build CLI 2026-09-16 21:03:17 +02:00
tests Own report and diagnostic plugins behind one build CLI 2026-09-16 21:03:17 +02:00
tools Avoid nonportable sorting in report validation batch 2026-09-16 21:04:40 +02:00
visual Separate report renderer and share visual elements 2026-09-16 20:08:11 +02:00
.gitignore feat: define generic report v1 contract and YAML JSON validator 2026-09-15 16:32:36 +02:00
Jenkinsfile Own report and diagnostic plugins behind one build CLI 2026-09-16 21:03:17 +02:00
LICENSE Initial commit 2026-09-15 14:49:58 +02:00
README.md Own report and diagnostic plugins behind one build CLI 2026-09-16 21:03:17 +02:00
build.sh Own report and diagnostic plugins behind one build CLI 2026-09-16 21:03:17 +02:00
render.sh Own report and diagnostic plugins behind one build CLI 2026-09-16 21:03:17 +02:00

README.md

Reportist

Reportist renders authored YAML/JSON reports and raw WinDiagnostics captures. The report and diagnostic plugins own their document structure independently; both use visual/elements.typ and visual/themes.yaml.

build.sh is the public CLI and works without the Beffroi macro checkout:

./build.sh render report examples/example-report.yaml --output report.pdf
./build.sh render diagnostic plugins/diagnostics/tests/fixtures/legacy/windiagnostics-v1.json --output diagnostic.pdf
./build.sh render-all report /path/to/reports --output-dir /path/to/pdfs
./build.sh render-all diagnostic /path/to/captures --output-dir /path/to/pdfs

It also exposes analyze, analyze-all, validate, validate-all, and export-json-all. See the CLI contract for arguments and output behavior. tests/test.sh runs both plugin test suites.