Skip to main content

Module output

Module output 

Expand description

Output emitters: CSV, SARIF, JSON, Markdown, Parquet, SQLite. The banner module renders the stderr pre-flight banner shown at the start of every analyze run.

Modules§

banner
Pre-flight banner emitted to stderr at the start of an analyze run.
csv
CSV emitters. Headers match code-maat exactly for golden-test parity.
gha
GitHub Actions workflow-command output emitter.
html
Static-HTML report emitter (T11). One self-contained HTML file per analysis run — embedded CSS + vanilla JS, no external CDN, no framework dependency.
json
JSON output emitter for all analyses.
markdown
Markdown output emitter for $GITHUB_STEP_SUMMARY and human-readable CI artifacts.
ndjson
Newline-delimited JSON (NDJSON / JSON Lines) output emitter.
parquet
Parquet output via DuckDB COPY … TO … (FORMAT PARQUET).
sarif
SARIF 2.1.0 emitter for hotspot results — Behavioral SARIF taxonomy (spec §5.4).
sqlite
SQLite output via DuckDB ATTACH … (TYPE SQLITE).

Functions§

atomic_publish
Publish a file atomically: write the payload to a process-unique temp sibling of dest, then rename it over dest only after write succeeds. An interrupted or failing write leaves any previous dest untouched — the half-written bytes live only in the temp file, which is removed on error. This is the single output-write choke point every emitter routes through so a ^C (or a mid-write failure) can never truncate a good previous output.