status

Documentation

Index

• func BadgeColor(coverage int) string
• func FormatBadgeMarkdown(coverage int, label string) string
• type CoverageResult
  • func CalculateCoverage(docsDir string, gitAdapter domain.GitAdapter) CoverageResult
• type StatusInfo
  • func CollectStatus(cfg *config.Config, git domain.GitAdapter, loreDir string) (*StatusInfo, error)

Functions

func BadgeColor

func BadgeColor(coverage int) string

BadgeColor returns the shields.io color hex for a coverage percentage.

func FormatBadgeMarkdown

func FormatBadgeMarkdown(coverage int, label string) string

FormatBadgeMarkdown generates a shields.io badge markdown snippet.

Types

type CoverageResult

type CoverageResult struct {
	TotalCommits  int
	MergeCommits  int
	RebaseCommits int
	Eligible      int
	Documented    int
	DocSkipped    int
	Covered       int
	Gaps          int
	Coverage      int     // 0-100 percentage
	SkipRate      float64 // 0-1
}

CoverageResult holds documentation coverage metrics.

func CalculateCoverage

func CalculateCoverage(docsDir string, gitAdapter domain.GitAdapter) CoverageResult

CalculateCoverage computes documentation coverage for the repository.

type StatusInfo

type StatusInfo struct {
	ProjectName          string
	HookInstalled        bool
	DocCount             int
	PendingCount         int
	ExpressCount         int
	CompleteCount        int
	ReadErrors           int
	AngelaMode           string // "draft", "polish"
	AIProvider           string // "anthropic", "openai", ""
	HealthIssues         int
	AngelaSuggestions    int             // total suggestions across all docs
	AngelaDocsNeedReview int             // docs with at least 1 suggestion
	Coverage             *CoverageResult // doc coverage (nil when git is unavailable)
}

StatusInfo holds all data needed to render the status dashboard.

func CollectStatus

func CollectStatus(cfg *config.Config, git domain.GitAdapter, loreDir string) (*StatusInfo, error)

CollectStatus gathers all status information from the repository.