Module markdown
Expand description
Markdown output emitter for $GITHUB_STEP_SUMMARY and human-readable
CI artifacts.
Writers are grouped into per-domain submodules and re-exported here so
callers keep the flat output::markdown::write_* paths. Shared helpers
live in this module.
Functions§
- escape_
md_ cell - Escape a string for safe inclusion inside a GFM table cell.
- write_
abs_ churn_ markdown - write_
arch_ violations_ markdown - architecture-violations markdown emitter — one row per import edge that crosses a forbidden layer boundary.
- write_
architecture_ metrics_ markdown - write_
architecture_ roles_ markdown - architecture-roles markdown emitter — per-file role + visibility reach.
- write_
architecture_ trend_ markdown architecture-trendmarkdown emitter — structural decay over time.- write_
author_ churn_ markdown - write_
authors_ markdown - write_
bus_ factor_ markdown - bus-factor markdown emitter.
- write_
centrality_ markdown - write_
clone_ coupling_ markdown - write_
clones_ markdown - write_
code_ age_ markdown - write_
code_ familiarity_ markdown - write_
code_ health_ markdown - write_
communication_ markdown - write_
communities_ markdown - write_
coordination_ needs_ markdown - write_
coupling_ markdown - write_
crossing_ markdown - crossing markdown emitter — structural “X” files coupling upstream and downstream through themselves (DV8 Crossing).
- write_
cycle_ health_ markdown cycle-healthmarkdown emitter — per-SCC heat, verdict, extraction candidate, and predicted propagation-cost drop.- write_
cycle_ origins_ markdown - architecture-metrics markdown emitter — repo-level
(metric, value).cycle-originsmarkdown emitter — when each HEAD cycle first formed. - write_
defect_ validation_ markdown defect-validationmarkdown emitter — flat(metric, value)evidence rows from a defect-calibration artifact. Empty (no artifact configured) prints an honest-absence note pointing atcodelore calibrate-defects.- write_
delivery_ friction_ markdown - delivery-friction markdown emitter.
- write_
delivery_ metrics_ markdown - write_
dependency_ cycles_ markdown - dependency-cycles markdown emitter — one row per (cycle, member).
- write_
effort_ exposure_ markdown - write_
entity_ churn_ markdown - write_
entity_ effort_ markdown - write_
entity_ ownership_ markdown - write_
finding_ hotspot_ overlap_ markdown - write_
function_ coupling_ markdown - write_
function_ hotspots_ markdown function-hotspotsmarkdown emitter — repo-wide function-level hotspot ranking (revs × cognitive, thehotspotsscoring shape at function granularity).- write_
function_ xray_ markdown - write_
god_ classes_ markdown - god-classes markdown emitter — cognitive ×
fan_in×fan_outintersection. Top-of-list files have all three pulling up. - write_
health_ trend_ markdown health-trendmarkdown emitter — repo health timeline across sampled revs.- write_
hotspot_ velocity_ markdown hotspot-velocitymarkdown emitter — files ranked by change acceleration (heating up first).- write_
hotspots_ markdown - write_
instability_ markdown - instability markdown emitter — Martin Ca/Ce/Instability per file.
- write_
knowledge_ islands_ markdown - write_
lead_ time_ markdown - lead-time markdown emitter.
- write_
main_ dev_ by_ deletions_ markdown - write_
main_ dev_ by_ revs_ markdown - write_
main_ dev_ markdown - write_
marginal_ owner_ risk_ markdown - write_
messages_ markdown - write_
modularity_ violations_ markdown - modularity-violations markdown emitter — Fisher-significant co-change pairs with no structural import edge.
- write_
ownership_ markdown - write_
pair_ programming_ markdown - pair-programming markdown emitter.
- write_
refactoring_ targets_ markdown - Markdown table emitter for the
refactoring-targetsanalysis. - write_
release_ cadence_ markdown - write_
revisions_ markdown - write_
soc_ markdown - write_
stale_ code_ markdown - stale-code markdown emitter.
- write_
summary_ markdown - write_
team_ composition_ markdown team-compositionmarkdown emitter.- write_
top_ committers_ markdown - write_
unstable_ interface_ markdown - unstable-interface markdown emitter — interfaces whose instability propagates to their dependents.