Module render

Expand description

Output rendering — the detail ladder.

The shape of what we print is the product (docs/adr/0003-output-ladder.md). Two rules hold everywhere in this module:

Field order is fixed. A view that reorders itself between calls breaks an agent’s prompt cache and any script that reads the output.
Free text coming from Tracker is fenced. Summaries, descriptions and comments were written by other people and may contain instructions aimed at whatever reads them; they are data, and they are labelled as such.

Snapshot tests cover every renderer, so changing a default shape shows up as a diff in review rather than as a surprise in someone’s pipeline.

Modules§

board: Boards and their sprints.
dict: The organisation’s dictionaries: issue types, priorities, statuses, resolutions.
entity: Projects, goals and attachments.
image: Drawing an image in terminals that can draw one.
markdown: Markdown, rendered for a terminal.
progress: Saying that a long walk is still walking.
queue: Queue listings and field tables.
style: Colour and emphasis.
table: Listings, in the two shapes their two readers need.
text: The compact text view.
untrusted: Fencing for text that Tracker users wrote.
user: People.