sources

package
v0.2.2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Aug 28, 2026 License: Apache-2.0 Imports: 4 Imported by: 0

Documentation

Overview

Package sources resolves requirement-ID prefixes to their origin: a local flatfile series (e.g. CBIN-105) or an external ticket system (JIRA, GitLab, GitHub) configured in .canary/project.yaml under `sources:`. CANARY: REQ=CBIN-201; FEATURE="TicketSources"; ASPECT=Engine; STATUS=TESTED; TEST=TestCANARY_CBIN_201_RegistryPattern; UPDATED=2026-08-28

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Registry 

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

Registry answers ID-shaped questions for a set of sources.

func Default 

func Default() *Registry

Default returns the registry used when no sources are configured: the historical CBIN flatfile series.

func FromProjectConfig 

func FromProjectConfig(cfg *config.ProjectConfig) *Registry

FromProjectConfig builds a registry from a parsed project config. When the config declares no sources, a flatfile source is synthesized from project.key; if the key is empty or invalid, falls back to Default() (CBIN).

func LoadFromRoot 

func LoadFromRoot(root string) *Registry

LoadFromRoot reads .canary/project.yaml under root. Any error falls back to Default() — sources config must never break a scan.

func NewRegistry 

func NewRegistry(list []Source) (*Registry, error)

NewRegistry validates the sources and builds the combined ID pattern.

func (*Registry) ClaimPattern 

func (r *Registry) ClaimPattern() *regexp.Regexp

ClaimPattern matches "✅ <ID>" gap-analysis claim lines (ID in group 1).

func (*Registry) Normalize 

func (r *Registry) Normalize(id string) string

Normalize zero-pads flatfile IDs to at least 3 digits (CBIN-42 → CBIN-042). External ticket IDs and unknown prefixes are returned verbatim.

func (*Registry) Pattern 

func (r *Registry) Pattern() *regexp.Regexp

Pattern matches any configured requirement ID (captured in group 1).

func (*Registry) Resolve 

func (r *Registry) Resolve(id string) (Source, bool)

Resolve returns the source owning id's prefix.

func (*Registry) Sources 

func (r *Registry) Sources() []Source

Sources returns the configured sources in declaration order.

func (*Registry) TicketURL 

func (r *Registry) TicketURL(id string) string

TicketURL expands the owning source's URL template. Empty when the source is flatfile, unknown, or has no URL configured.

type Source 

type Source struct {
	Name string
	Type string // flatfile | jira | github | gitlab
	Key  string // uppercase ID prefix, e.g. "CBIN", "PLAT"
	URL  string // optional template; {id} = full ID, {num} = numeric part
}

Source is one configured requirement-ID origin.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.