worktree

type Entry struct {
	stack.Worktree
	// Status is "up", "down", "adoptable" for a worktree wtm has not adopted,
	// or "-" when docker could not be reached.
	Status string
	// ComposeProject is what `docker compose -p` takes, empty until an index
	// is recorded: before that, docker holds the only name there is.
	ComposeProject string
}

type Options struct {
	Name         string // project name in the registry
	Project      config.Project
	Branch       string
	Base         string
	NoStart      bool
	NoPostCreate bool // skip the project's post_create on this create
	// RunAfter and ExecAfter are the commands of `create --run` and `create
	// --exec`, played once the create is done: the first on the host from the
	// worktree, the second in the container. Shell lines, never persisted.
	RunAfter  string
	ExecAfter string
	// Profile is the stack profile this start brings up, empty for the whole
	// stack. Deliberately not remembered: a worktree narrowed months ago, with
	// nothing on screen saying so, is a puzzle, and naming it again is one word.
	Profile string
	Force   bool // remove despite uncommitted tracked changes
	// Inferred says nobody named this branch: `wtm create` releasing a vanished
	// worktree's index acts on a guess, so it refuses to take down a stack that
	// still runs. A branch somebody typed or confirmed sweeps what it was asked to.
	Inferred   bool
	BackupsDir string
	Runner     execx.Runner
	Out        io.Writer
	Stack      *stack.Client
	Resolver   *index.Resolver // resolves and records each branch's stable index
	// Confirm asks a yes-or-no question, and is nil when nobody is there to
	// answer. Its only caller is the memory advisory, an average over the
	// running stacks: worth a question, never worth failing a create on.
	Confirm func(question string) bool
	// BaseFromHere says Base came from `create --from-here` rather than from the
	// project or the command line. An existing branch is checked out as-is and
	// ignores the base, so that combination is refused rather than logged.
	BaseFromHere bool
	// RenameTo is the name an adopted branch takes. Adoption is the only
	// moment a rename is free: the compose project name carries the branch, so
	// renaming once a stack exists orphans the stack it names.
	RenameTo string
	// ConfirmAdopt asks before writing into a worktree wtm did not create. It
	// is deliberately not Confirm: --ignore-memory answers the memory advisory
	// alone, and must not also wave through a write into somebody's checkout.
	ConfirmAdopt func(question string) bool
}

type RemovalKind int

type RemovalPlan struct {
	Kind RemovalKind
	// Path is the worktree, or the directory git forgot. Empty for RemoveStale.
	Path string
	// Index is the one the registry records, 0 when it holds none.
	Index      int
	Locked     bool
	LockReason string
	// Changes are the tracked changes of a created worktree, left unchecked
	// under Force: skipping that check is what --force is for.
	Changes string
	// contains filtered or unexported fields
}