Package tools/canary

Import path: go.devnw.com/canary/tools/canary

TYPES

API (raw go doc)

TYPES

type AspectCounts map[string]int

func (m AspectCounts) MarshalJSON() ([]byte, error)

type Feature struct {
    Feature string   `json:"feature"`
    Aspect  string   `json:"aspect"`
    Status  string   `json:"status"`
    Files   []string `json:"files"`
    Tests   []string `json:"tests"`
    Benches []string `json:"benches"`
    Owner   string   `json:"owner,omitempty"`
    Updated string   `json:"updated"`
}

type ProjectConfig struct {
    Project struct {
        Name        string `yaml:"name"`
        Description string `yaml:"description"`
    } `yaml:"project"`
    Requirements struct {
        IDPattern string `yaml:"id_pattern"`
    } `yaml:"requirements"`
    Scanner struct {
        ExcludePaths []string `yaml:"exclude_paths"`
    } `yaml:"scanner"`
}
    ProjectConfig defines project-specific configuration

type Report struct {
    GeneratedAt  string        `json:"generated_at"`
    Requirements []Requirement `json:"requirements"`
    Summary      Summary       `json:"summary"`
}

type Requirement struct {
    ID       string    `json:"id"`
    Features []Feature `json:"features"`
}

type StatusCounts map[string]int

func (m StatusCounts) MarshalJSON() ([]byte, error)

type Summary struct {
    ByStatus           StatusCounts `json:"by_status"`
    ByAspect           AspectCounts `json:"by_aspect"`
    TotalTokens        int          `json:"total_tokens"`
    UniqueRequirements int          `json:"unique_requirements"`
}