Expand description
§tokmd-format
Tier 2 (Formatting)
This crate handles the rendering and serialization of tokmd receipts.
It supports Markdown, TSV, JSON, JSONL, CSV, and CycloneDX formats.
§What belongs here
- Serialization logic (JSON/CSV/CycloneDX)
- Markdown and TSV table rendering
- Output file writing
- Redaction integration (via internal
redactmodule) - ScanArgs integration (via internal
scan_argsmodule) - Analysis receipt rendering under
analysis
§What does NOT belong here
- Business logic (calculating stats)
- CLI argument parsing
- Analysis computation (use tokmd-analysis)
Re-exports§
pub use badge::badge_svg;pub use export_tree::render_analysis_tree;pub use export_tree::render_handoff_tree;pub use redact::redact_path;pub use redact::short_hash;pub use scan_args::normalize_scan_input;pub use scan_args::scan_args;
Modules§
- analysis
- Analysis receipt rendering.
- badge
- SVG badge rendering helpers.
- export_
tree - Deterministic tree renderers from
ExportData. - redact
- tokmd-format::redact
- scan_
args - Deterministic scan argument construction for receipt metadata.
Structs§
Enums§
Functions§
- compute_
diff_ rows - Compute diff rows from two lang reports. Compute diff rows between two language reports.
- compute_
diff_ totals - Compute totals from diff rows.
- create_
diff_ receipt - Create a DiffReceipt for JSON output.
- print_
lang_ report - Print a language report to stdout.
- print_
module_ report - Print a module report to stdout.
- render_
diff_ md - Render diff as Markdown table.
- render_
diff_ md_ with_ options - Render diff as Markdown table with optional compact/color behavior.
- write_
export - write_
export_ jsonl_ to_ file - Write export data as JSONL to a file path.
- write_
lang_ json_ to_ file - Write a lang report as JSON to a file path.
- write_
lang_ report_ to - Write a language report to a writer.
- write_
module_ json_ to_ file - Write a module report as JSON to a file path.
- write_
module_ report_ to - Write a module report to a writer.