openspecmetrics

Documentation

Overview

Package openspecmetrics computes structural OpenSpec indexing diagnostics.

Index

• type Artifact
• type Metrics
  • func Analyze(repoRoot string, artifacts []Artifact) Metrics
  • func (m Metrics) HasData() bool

Types

type Artifact

type Artifact struct {
	Path           string
	SourceType     string
	SourceIdentity string
	Subtype        string
	ArtifactScope  string
	OpenSpecRole   string
}

type Metrics

type Metrics struct {
	ExpectedBundles        int            `json:"expected_bundles"`
	IndexedBundles         int            `json:"indexed_bundles"`
	BundleRecall           float64        `json:"bundle_recall"`
	MissingBundles         []string       `json:"missing_bundles,omitempty"`
	ExpectedChildRoles     map[string]int `json:"expected_child_roles,omitempty"`
	IndexedChildRoles      map[string]int `json:"indexed_child_roles,omitempty"`
	ExpectedChildArtifacts int            `json:"expected_child_artifacts"`
	IndexedChildArtifacts  int            `json:"indexed_child_artifacts"`
	ChildRoleRecall        float64        `json:"child_role_recall"`
	MissingChildRoles      []string       `json:"missing_child_roles,omitempty"`
	DuplicatePressure      float64        `json:"duplicate_pressure"`
	MarkdownLeakage        int            `json:"markdown_leakage"`
	MarkdownLeakagePaths   []string       `json:"markdown_leakage_paths,omitempty"`
}

func Analyze

func Analyze(repoRoot string, artifacts []Artifact) Metrics

func (Metrics) HasData

func (m Metrics) HasData() bool