Skip to main content

Module analysis

tokmd_format

Module analysis 

Source
Expand description

Analysis receipt rendering.

This module owns analysis-specific formatting under the durable tokmd-format capability crate. It supports Markdown, JSON, JSON-LD, XML, SVG, Mermaid, HTML, and optional fun outputs.

§Effort rendering

Effort sections are rendered in two tiers:

  1. receipt.effort the preferred path for the newer effort-estimation receipt surface. This can render size basis, confidence, drivers, assumptions, and optional delta data.
  2. derived.cocomo a legacy fallback used when the richer effort section is absent but classic derived COCOMO data is present.

The formatter intentionally renders whatever the receipt contains without inferring missing estimate data. If the upstream effort builder is still scaffold-only, the formatter preserves that truth rather than making the estimate look more complete than it is.

§What belongs here

  • Analysis receipt rendering to various formats
  • Format-specific transformations
  • Fun output integration (OBJ, MIDI when enabled)

§What does NOT belong here

  • Analysis computation (use tokmd-analysis)
  • CLI argument parsing
  • Analysis computation (use tokmd-analysis)

Modules§

html
Analysis HTML rendering.

Enums§

RenderedOutput

Functions§

render