beads

package
v0.5.0 Latest Latest
Warning

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

Go to latest
Published: Feb 9, 2026 License: MIT Imports: 8 Imported by: 0

Documentation

Index

Constants

View Source
const BeadsDir = ".beads"

BeadsDir is the standard directory for beads data.

View Source
const IssuesFile = "issues.jsonl"

IssuesFile is the standard filename for beads issues.

Variables

This section is empty.

Functions

func FilterAgainstExisting

func FilterAgainstExisting(signals []signal.RawSignal, existing []Bead) []signal.RawSignal

FilterAgainstExisting removes signals that match existing beads. Matching is done via 3 tiers: ID match, hash match, and normalized title match. Both open and closed beads are matched to avoid re-opening resolved work.

Types

type Bead

type Bead struct {
	ID        string   `json:"id"`
	Title     string   `json:"title"`
	Status    string   `json:"status"`
	Type      string   `json:"type,omitempty"`
	IssueType string   `json:"issue_type,omitempty"`
	Priority  int      `json:"priority"`
	Labels    []string `json:"labels,omitempty"`
}

Bead represents a single issue from the beads backlog.

func LoadBeads

func LoadBeads(repoPath string) ([]Bead, error)

LoadBeads reads and parses the .beads/issues.jsonl file from a repo path. Returns nil, nil if the file does not exist.

type Conventions

type Conventions struct {
	// IDPrefix is the dominant ID prefix (e.g., "stringer-", "str-", "app-").
	IDPrefix string

	// LabelStyle is the detected label style: "kebab-case" or "snake_case".
	LabelStyle string

	// UseIssueType indicates whether existing beads use "issue_type" vs "type".
	UseIssueType bool

	// MinPriority is the minimum priority value seen.
	MinPriority int

	// MaxPriority is the maximum priority value seen.
	MaxPriority int
}

Conventions holds detected beads conventions from existing issues.

func DetectConventions

func DetectConventions(existing []Bead) *Conventions

DetectConventions analyzes existing beads to detect naming conventions.

Jump to

Keyboard shortcuts

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