ticket

package

v0.1.2 Latest Latest Go to latest Published: Sep 12, 2026 License: MIT Imports: 3 Imported by: 0

Details

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

Repository

github.com/idosaban-scaleops/flow

Links

Open Source Insights

Documentation ¶

Overview ¶

Package ticket turns what a user types into the exact names flow uses on disk. The naming rules here are load-bearing: the branch and worktree use a hyphen between ID and slug, the assets directory uses an underscore, and both must be reproduced identically on every later invocation.

Index ¶

Constants
func IDFromBranch(branch string) (string, bool)
func LooksLikeID(s string) bool
func NormalizeID(raw string) (string, error)
func Slugify(raw string) (string, error)
type ErrInvalid
- func (e *ErrInvalid) Error() string
type Ticket
- func New(id, description string) (Ticket, error)
- func ParseDirName(name string) (Ticket, bool)
- func (t Ticket) Expand(template string) string

Constants ¶

View Source

const MaxSlugLen = 60

MaxSlugLen bounds the slug so that worktree paths stay manageable.

Variables ¶

This section is empty.

Functions ¶

func IDFromBranch ¶

func IDFromBranch(branch string) (string, bool)

IDFromBranch extracts a ticket ID from a branch name, for branches flow did not create itself.

func LooksLikeID ¶

func LooksLikeID(s string) bool

LooksLikeID reports whether s could be a ticket ID, so that commands taking an optional ticket argument can tell one from a flag value.

func NormalizeID ¶

func NormalizeID(raw string) (string, error)

NormalizeID uppercases and validates a ticket ID: "rd-19471" becomes "RD-19471", and anything that is not PROJECT-NUMBER is rejected.

func Slugify ¶

func Slugify(raw string) (string, error)

Slugify normalizes a free-text description into the slug used in branch, worktree and assets names.

Types ¶

type ErrInvalid ¶

type ErrInvalid struct {
	What  string
	Input string
	Why   string
}

ErrInvalid reports input flow cannot turn into a ticket. Callers map it to exit code 2.

func (*ErrInvalid) Error ¶

func (e *ErrInvalid) Error() string

type Ticket ¶

type Ticket struct {
	ID   string
	Slug string
}

Ticket is a normalized ticket identity.

func New ¶

func New(id, description string) (Ticket, error)

New normalizes an ID and a description into a Ticket.

func ParseDirName ¶

func ParseDirName(name string) (Ticket, bool)

ParseDirName recovers a ticket from a worktree directory name such as "RD-19471-add-new-toolbar".

func (Ticket) Expand ¶

func (t Ticket) Expand(template string) string

Expand substitutes {id} and {slug} in a naming template.

Source Files ¶

View all Source files

ticket.go

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