Skip to main content

Module markdown

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-trend markdown 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-health markdown 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-origins markdown emitter — when each HEAD cycle first formed.
write_defect_validation_markdown
defect-validation markdown emitter — flat (metric, value) evidence rows from a defect-calibration artifact. Empty (no artifact configured) prints an honest-absence note pointing at codelore 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-hotspots markdown emitter — repo-wide function-level hotspot ranking (revs × cognitive, the hotspots scoring shape at function granularity).
write_function_xray_markdown
write_god_classes_markdown
god-classes markdown emitter — cognitive × fan_in × fan_out intersection. Top-of-list files have all three pulling up.
write_health_trend_markdown
health-trend markdown emitter — repo health timeline across sampled revs.
write_hotspot_velocity_markdown
hotspot-velocity markdown 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-targets analysis.
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-composition markdown emitter.
write_top_committers_markdown
write_unstable_interface_markdown
unstable-interface markdown emitter — interfaces whose instability propagates to their dependents.