markdown

Documentation

Overview

Package markdown renders a Diagnostic as Balanced-Coupling-aligned Markdown: lint-message advisory format, BC vocabulary throughout, clearly-labeled "Supporting structural metrics (beyond Balanced Coupling)" and "Distance confidence" sections. Reads well both as raw text and rendered Markdown; parseable by AI agents without NLP.

Index

• type Renderer
  • func New() *Renderer
  • func (r *Renderer) Format() string
  • func (r *Renderer) Render(d diagnostic.Diagnostic, w io.Writer) error

Types

type Renderer

type Renderer struct{}

Renderer formats a Diagnostic as BC-aligned Markdown. Satisfies engine.Renderer.

func New

func New() *Renderer

New returns a Renderer.

func (*Renderer) Format

func (r *Renderer) Format() string

Format returns "markdown".

func (*Renderer) Render

func (r *Renderer) Render(d diagnostic.Diagnostic, w io.Writer) error

Render writes the BC-aligned Markdown report for d to w. Sections follow design §8:

1. Verdict + config_hash + tool/coverage
2. Gate violations (rules)
3. Balanced Coupling advisories — lint-message format
4. Supporting structural metrics (beyond Balanced Coupling)
5. Distance confidence
6. Agent tasks