worktree

Documentation

Index

• func BranchName(name string) string
• func CanonicalRepoRoot(cwd string) (string, error)
• func CheckoutRoot(cwd string) (string, error)
• func FlattenName(name string) string
• func ValidateManagedName(name string) error
• func ValidateName(name string) error
• func WorktreePath(repoRoot, name string) string
• type ChangeSummary
  • func CountChanges(path, originalWorkspace, originalHeadCommit string) (ChangeSummary, error)
• type Entry
  • func List(cwd string) ([]Entry, error)
  • func Status(cwd, name string) (Entry, error)
• type RemoveResult
  • func Remove(cwd, name string, force bool) (RemoveResult, error)
• type Session
  • func Start(cwd, name string) (Session, error)

Functions

func BranchName

func BranchName(name string) string

func CanonicalRepoRoot

func CanonicalRepoRoot(cwd string) (string, error)

func CheckoutRoot

func CheckoutRoot(cwd string) (string, error)

func FlattenName

func FlattenName(name string) string

func ValidateManagedName

func ValidateManagedName(name string) error

func ValidateName

func ValidateName(name string) error

func WorktreePath

func WorktreePath(repoRoot, name string) string

Types

type ChangeSummary

type ChangeSummary struct {
	ChangedFiles int
	IgnoredFiles int
	Commits      int
}

func CountChanges

func CountChanges(path, originalWorkspace, originalHeadCommit string) (ChangeSummary, error)

type Entry

type Entry struct {
	Name    string
	Path    string
	Branch  string
	Head    string
	Dirty   bool
	Missing bool
}

func List

func List(cwd string) ([]Entry, error)

func Status

func Status(cwd, name string) (Entry, error)

type RemoveResult

type RemoveResult struct {
	Entry         Entry
	BranchDeleted bool
	BranchWarning string
}

func Remove

func Remove(cwd, name string, force bool) (RemoveResult, error)

type Session

type Session struct {
	Name               string
	Path               string
	Branch             string
	OriginalWorkspace  string
	OriginalBranch     string
	OriginalHeadCommit string
	Created            bool
}

func Start

func Start(cwd, name string) (Session, error)