featureops

type CreateOptions struct {
	// ProjectDir is the parent project: the top level of a git work tree
	// that is not itself a feature. Must be absolute.
	ProjectDir string
	// Name is the human name. The slug is derived from it unless Slug is set.
	Name string
	Slug string
	// Description is the feature's goal. Empty uses Name.
	Description string
	// Base is the branch to cut the feature from and to target with its pull
	// request. Empty picks DefaultBase.
	Base string

	// Run settings, independent of the parent's.
	AutoEvolve  bool
	Innovate    bool
	Parallel    bool
	MaxParallel int

	// Tasks seeds the feature's plan, one title per task, in order. Empty
	// leaves the plan empty, and the first run decomposes the goal.
	Tasks []string

	// AutoPR asks the hub to open the pull request when the plan completes.
	AutoPR bool

	CreatedBy string
	// Now is the clock; nil uses time.Now.
	Now func() time.Time
}

type DirtyError struct {
	Slug  string
	Files []string
}

type GitStatus struct {
	// Head is the commit the feature's branch points at.
	Head string `json:"head,omitempty"`
	// Ahead counts commits on the feature that its base does not have — what
	// a pull request would carry. Behind counts the reverse.
	Ahead  int `json:"ahead"`
	Behind int `json:"behind"`
	// Dirty counts uncommitted changes in the worktree.
	Dirty int `json:"dirty"`
	// OnBranch reports that the worktree still has the feature's branch
	// checked out.
	OnBranch bool `json:"on_branch"`
	// Error explains a status that could not be determined.
	Error string `json:"error,omitempty"`
}

type HubEnv func(extra ...[2]string) []string

type PROptions struct {
	FeatureDir string
	// Title and Body override the generated ones.
	Title string
	Body  string
	// Base overrides the feature's recorded base branch.
	Base  string
	Draft bool
	// Remote is the git remote to push to and to derive the repository from.
	// Empty means origin.
	Remote string
	// NoPush skips the push, for a branch that is already published.
	NoPush bool
	// Token is an explicit API token; empty resolves one (see ResolveToken).
	Token string
	// Repo overrides the owner/name derived from the remote.
	Repo string
	// APIURL overrides the forge API base URL.
	APIURL string
	// Now is the clock; nil uses time.Now.
	Now func() time.Time
}

type PRResult struct {
	PR *feature.PR `json:"pr"`
	// Existing reports that the pull request was already open and was
	// returned rather than created.
	Existing bool `json:"existing"`
	Pushed   bool `json:"pushed"`
	// Ahead is how many commits the pull request carries.
	Ahead int `json:"ahead"`
	// Dirty lists uncommitted changes, which the pull request does not
	// contain. Reported rather than refused: the committed work is still
	// worth proposing, and the caller says so to the user.
	Dirty []string `json:"dirty,omitempty"`
	// TokenSource names where the API token came from, never the token.
	TokenSource string `json:"token_source"`
}

type Remote struct {
	// Host is the forge's host name, e.g. github.com.
	Host string
	// Repo is owner/name.
	Repo string
	// HTTPS reports that the remote is reached over https, which is when a
	// token can authenticate the push itself.
	HTTPS bool
}

type RemoveOptions struct {
	ProjectDir string
	Slug       string
	// DeleteBranch also deletes the feature's branch — only when git
	// considers it merged, unless Force.
	DeleteBranch bool
	// Force discards uncommitted changes, and with DeleteBranch deletes an
	// unmerged branch.
	Force bool
}

type RemoveResult struct {
	Path          string `json:"path"`
	Branch        string `json:"branch"`
	BranchDeleted bool   `json:"branch_deleted"`
	// BranchKept explains why a requested branch deletion did not happen.
	BranchKept string `json:"branch_kept,omitempty"`
}