markdown

Documentation

Overview

Package markdown generates markdown reports from analysis data

Index

• Variables
• type Category
  • func AllCategories() []Category
• type Generator
  • func New(opts *Options) (*Generator, error)
  • func (g *Generator) Generate() error
• type Options

Variables

var CategoryAnalyzers = map[Category][]string{
	CategorySpeed:       {"devops"},
	CategoryQuality:     {"code-quality"},
	CategoryTeam:        {"code-ownership", "developer-experience"},
	CategorySecurity:    {"code-security"},
	CategorySupplyChain: {"code-packages"},
	CategoryTechnology:  {"technology-identification"},
}

CategoryAnalyzers maps categories to their analyzers

Types

type Category

type Category string

Category represents one of the 6 pillars of engineering intelligence Order: Productivity (Speed, Quality, Team) → Technical (Security, Supply Chain, Technology)

const (
	CategorySpeed       Category = "speed"        // DORA metrics, cycle time, delivery
	CategoryQuality     Category = "quality"      // Tech debt, complexity, coverage
	CategoryTeam        Category = "team"         // Ownership, collaboration, devx
	CategorySecurity    Category = "security"     // Vulnerabilities, secrets, crypto
	CategorySupplyChain Category = "supply-chain" // Dependencies, licenses, SBOM
	CategoryTechnology  Category = "technology"   // Stack detection, AI/ML security
)

func AllCategories

func AllCategories() []Category

AllCategories returns all available categories in framework-aligned order

type Generator

type Generator struct {
	// contains filtered or unexported fields
}

Generator creates markdown reports from analysis data

func New

func New(opts *Options) (*Generator, error)

New creates a new report generator

func (*Generator) Generate

func (g *Generator) Generate() error

Generate creates the markdown report

type Options

type Options struct {
	Project   string   // Project ID (owner/repo)
	Category  Category // Generate report for specific category
	Analyzer  string   // Generate report for specific analyzer
	Output    string   // Output file path (empty = stdout)
	Benchmark bool     // Show benchmark tier comparisons
}

Options configures the report generator