reqid

package

v0.3.10 Latest Latest Go to latest Published: Sep 20, 2026 License: Apache-2.0 Imports: 10 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

gitlab.com/devnw/codepros/oss/canary

Links

Open Source Insights

Documentation ¶

Overview ¶

CANARY: REQ=ENG-4316; FEATURE="AspectIDGenerator"; ASPECT=Engine; STATUS=IMPL; UPDATED=2025-10-16

CANARY: REQ=ENG-4316; FEATURE="AspectIDParser"; ASPECT=Engine; STATUS=IMPL; UPDATED=2025-10-16

CANARY: REQ=REQ-151; FEATURE="FixedPrefixes"; ASPECT=Engine; STATUS=IMPL; UPDATED=2025-11-01

CANARY: REQ=ENG-4316; FEATURE="AspectValidator"; ASPECT=Engine; STATUS=IMPL; UPDATED=2025-10-16

Index ¶

Constants
Variables
func GenerateNextID(key, aspect string) (string, error)
func GenerateNextIDIn(root, key, aspect string) (string, error)
func GenerateNextIDInContext(ctx context.Context, root, key, aspect string) (string, error)
func NormalizeAspect(input string) string
func SuggestAspect(typo string) string
func ValidateAspect(aspect string) error
type ID
type IDType
type RequirementID
- func ParseRequirementID(reqID string) (*RequirementID, error)
- func (r *RequirementID) String() string

Constants ¶

View Source

const MaxSpecEntries = 10000

MaxSpecEntries bounds ID discovery, including unrelated entries. A suggested ID is not a reservation; callers still own concurrent creation coordination.

Variables ¶

View Source

var ErrSpecEntryLimit = errors.New("requirement ID discovery entry limit exceeded")

Functions ¶

func GenerateNextID ¶

func GenerateNextID(key, aspect string) (string, error)

GenerateNextID generates the next requirement ID for a given aspect using the cwd-relative .canary/specs directory.

func GenerateNextIDIn ¶ added in v0.3.0

func GenerateNextIDIn(root, key, aspect string) (string, error)

GenerateNextIDIn generates the next requirement ID for a given aspect within a specific root directory. The root parameter is used to locate .canary/specs; for cwd-relative behavior, pass ".".

func GenerateNextIDInContext ¶ added in v0.3.9

func GenerateNextIDInContext(ctx context.Context, root, key, aspect string) (string, error)

GenerateNextIDInContext discovers IDs only inside root, reading directories in bounded batches and checking cancellation between filesystem operations. Cancellation cannot interrupt a blocked kernel filesystem call.

func NormalizeAspect ¶

func NormalizeAspect(input string) string

NormalizeAspect normalizes aspect casing to the canonical form

func SuggestAspect ¶

func SuggestAspect(typo string) string

SuggestAspect returns fuzzy match suggestions for invalid aspects

func ValidateAspect ¶

func ValidateAspect(aspect string) error

ValidateAspect checks if the given aspect is valid Accepts: exact canonical form, all-lowercase, or all-uppercase Rejects: partial capitalizations (e.g., "Frontend" when it should be "FrontEnd")

Types ¶

type ID ¶

type ID struct {
	Type   IDType // REQ, TASK, or BUG
	Number int    // Numeric identifier (e.g., 123)

	// Relationships
	ParentID string // For TASK/BUG: the REQ or TASK this relates to (optional)
}

ID represents a parsed identifier (REQ, TASK, or BUG)

func New ¶

func New(typ IDType, number int) *ID

New creates a new ID

func NewBUG ¶

func NewBUG(number int) *ID

NewBUG creates a new BUG identifier

func NewREQ ¶

func NewREQ(number int) *ID

NewREQ creates a new REQ identifier

func NewTASK ¶

func NewTASK(number int) *ID

NewTASK creates a new TASK identifier

func Parse ¶

func Parse(id string) (*ID, error)

Parse parses an ID string into its components

func (*ID) IsBUG ¶

func (id *ID) IsBUG() bool

IsBUG returns true if this is a BUG identifier

func (*ID) IsREQ ¶

func (id *ID) IsREQ() bool

IsREQ returns true if this is a REQ identifier

func (*ID) IsTASK ¶

func (id *ID) IsTASK() bool

IsTASK returns true if this is a TASK identifier

func (*ID) String ¶

func (id *ID) String() string

String returns the string representation of the ID

func (*ID) Validate ¶

func (id *ID) Validate() error

Validate checks if the ID is valid

type IDType ¶

type IDType string

IDType represents the type of identifier

const (
	// TypeREQ represents a requirement specification
	TypeREQ IDType = "REQ"

	// TypeTASK represents a task within a requirement plan
	TypeTASK IDType = "TASK"

	// TypeBUG represents a bug related to a requirement or task
	TypeBUG IDType = "BUG"
)

type RequirementID ¶

type RequirementID struct {
	Key    string // e.g., "CBIN"
	Aspect string // e.g., "CLI", "API" (empty for v1 format)
	ID     string // e.g., "001", "042"
	Format string // "v1" (CBIN-XXX) or "v2" (CBIN-SECURITY_REVIEW-XXX)
}

RequirementID represents a parsed requirement identifier

func ParseRequirementID ¶

func ParseRequirementID(reqID string) (*RequirementID, error)

ParseRequirementID parses a requirement ID string into its components

func (*RequirementID) String ¶

func (r *RequirementID) String() string

String returns the string representation of the RequirementID

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL