Generic Typst-based report renderer. Turns structured YAML/JSON reports into sober, reproducible PDF documents.
Go to file
Dandaedre 5d37b6340d
Add rounded card content blocks to reports
2026-09-16 17:33:01 +02:00
docs Add rounded card content blocks to reports 2026-09-16 17:33:01 +02:00
examples feat: define generic report v1 contract and YAML JSON validator 2026-09-15 16:32:36 +02:00
schema Add rounded card content blocks to reports 2026-09-16 17:33:01 +02:00
templates Add rounded card content blocks to reports 2026-09-16 17:33:01 +02:00
tests Add rounded card content blocks to reports 2026-09-16 17:33:01 +02:00
tools Add rounded card content blocks to reports 2026-09-16 17:33:01 +02:00
.gitignore feat: define generic report v1 contract and YAML JSON validator 2026-09-15 16:32:36 +02:00
Jenkinsfile refactor: expose renderer at repository root 2026-09-16 02:13:26 +02:00
LICENSE Initial commit 2026-09-15 14:49:58 +02:00
README.md feat: restore legacy diagnostic rendering 2026-09-16 03:30:01 +02:00
render-diagnostic.sh feat: restore legacy diagnostic rendering 2026-09-16 03:30:01 +02:00
render-diagnostics.sh feat: restore legacy diagnostic rendering 2026-09-16 03:30:01 +02:00
render.sh refactor: expose renderer at repository root 2026-09-16 02:13:26 +02:00

README.md

Reportist

Reportist is a standalone structured-report maker. Give it a YAML or JSON report definition and it produces a PDF with Typst. It has no dependency on the Beffroi integration repository or diagnostic tools.

Render one report

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

The renderer validates the input, loads an optional report-relative logo, and writes the completed PDF. Existing output requires --force.

Render one diagnostic

./render-diagnostic.sh capture.json \
  --output diagnostic.pdf \
  --author "Reviewer Name" \
  --logo /path/to/logo.png

The diagnostic renderer supports the established Windows diagnostic JSON formats and layout. Select a configured color scheme with --theme NAME.

Render every diagnostic in a directory

./render-diagnostics.sh /path/to/diagnostics \
  --output-dir /path/to/pdfs \
  --author "Reviewer Name" \
  --logo /path/to/logo.png

Render every report in a directory

bash tools/render-all.sh /path/to/reports --output-dir /path/to/pdfs

Validate without rendering

bash tools/validate.sh examples/example-report.yaml
bash tools/validate-all.sh /path/to/reports

Start with examples/example-report.yaml or the smaller examples/minimal-report.json. See docs/report-contract.md for all fields and docs/development.md for tests and template development.