git

type AgitOptions struct {
	Directory, Remote, Head, Base, Topic, Title, Body string
	CredentialArgs                                    []string
	Prompt                                            bool
}

type BranchConfig struct {
	// Name is the local branch.
	Name string
	// Remote and Merge are the remote and branch the branch tracks, Merge without refs/heads/;
	// both are empty for a branch that tracks nothing or another local branch.
	Remote, Merge string
	// PullNumber and BaseRemote are what pr checkout recorded: the pull request the branch was
	// checked out from and the remote of that pull request's base repository.
	PullNumber int64
	BaseRemote string
}

type CheckoutOptions struct {
	// CredentialArgs contains per-operation Git configuration for the fetch only.
	CredentialArgs []string
	Directory      string
	Remote         string
	Number         int64
	Branch         string
	Detached       bool
	Update         bool
	Prompt         bool
	ExpectedCommit string
	// HeadRemote and HeadBranch select fork tracking when the head branch still exists.
	// When HeadBranch is empty, checkout fetches the retained pull ref from Remote.
	HeadRemote string
	HeadBranch string
}

type CheckoutResult struct {
	Detached bool   `json:"detached"`
	Branch   string `json:"branch"`
	Commit   string `json:"commit"`
	Remote   string `json:"remote,omitempty"`
	Tracking string `json:"tracking,omitempty"`
}

type CleanOptions struct {
	Directory, DefaultBranch, LocalBranch, Remote, RemoteBranch string
	CredentialArgs                                              []string
	Prompt, DeleteRemote                                        bool
}

type CleanResult struct {
	LocalBranch      string `json:"local_branch"`
	Remote           string `json:"remote,omitempty"`
	RemoteBranch     string `json:"remote_branch,omitempty"`
	DefaultBranch    string `json:"default_branch"`
	RemoteDeleted    bool   `json:"remote_deleted"`
	RemoteSkipped    bool   `json:"remote_skipped"`
	RemoteSkipReason string `json:"remote_skip_reason,omitempty"`
}

type CommandError struct{ ExitCode int }

type CredentialSetup struct {
	Directory, Instance, Executable, User, ConfigDirectory string
	Local                                                  bool
	// KeepHelpers adds gt's helper after other helpers instead of resetting them for the instance.
	KeepHelpers bool
}

type FindCleanBranchOptions struct {
	Directory, HeadSHA, HeadBranch  string
	DefaultBranch                   string
	PreferredNames, MatchingRemotes []string
	IgnoreSHA                       bool
	// PullNumber is the pull request being cleaned; a branch that pr checkout recorded for it
	// wins over branches that merely share the head branch's name.
	PullNumber int64
}

type InputRunner interface {
	Input(ctx context.Context, dir, input string, args ...string) (string, error)
}

type Runner interface {
	Output(context.Context, string, bool, ...string) (string, error)
}

type SyncOptions struct {
	Directory, Remote, Branch string
	CredentialArgs            []string
	Prompt                    bool
}

type SyncResult struct {
	Branch   string `json:"branch"`
	Commit   string `json:"commit"`
	Previous string `json:"previous"`
	Remote   string `json:"remote"`
}

type System struct {
	// Env overrides the subprocess environment when supplied.
	Env    []string
	In     io.Reader
	ErrOut io.Writer
}