cobracmd

type CommandOptions struct {
	// Use is the command name, including any argument hint shown in help
	// text. Defaults to "install [name...]".
	Use string
	// Short is the one-line help text. Defaults to a generic description.
	Short string
	// Aliases are additional names the command responds to.
	Aliases []string
	// HostID is the running host's own catalog id
	// (cli-install#req:host-identity-from-catalog). New panics if it is not
	// a valid catalog id — a programming error the host's own tests must
	// catch, never a runtime state a user sees, per that REQ.
	HostID string
	// Errors maps outcomes to the host's own error type. Required for a
	// host that wants distinguishable exit codes; a nil Errors makes every
	// failure return the underlying error unchanged.
	Errors ErrorMapper
	// Interactive reports whether the process is attached to an interactive
	// terminal, used to implement REQ: non-interactive-refusal for the
	// batch confirmation prompt. Passed straight through to
	// cliui.ConfirmOptions.Interactive; nil means that package's own
	// default. Tests should always override this.
	Interactive func() bool
	// HomebrewPrintOnly reports a Homebrew install's command instead of
	// running it, passed straight through to cliinstall.Options
	// (cli-install#req:homebrew-cask-install).
	HomebrewPrintOnly bool
	// ConfigureRelease optionally overrides a target's resolved
	// selfupdate.Config before it is used to resolve or install that
	// target's release — the release-endpoint injection point
	// cli-install#req:no-network-in-tests requires. Nil keeps the
	// catalog's own defaults (the real GitHub API).
	ConfigureRelease func(target cliinstall.Entry, cfg selfupdate.Config) selfupdate.Config
	// Env carries every side-effecting dependency Probe and Install use.
	// Left unset (a zero cliinstall.InstallEnv), New uses
	// cliinstall.DefaultInstallEnv() — the real host. Tests always set
	// this, exactly as cli-install#req:no-network-in-tests requires.
	Env cliinstall.InstallEnv
	// ProbeOptions tunes status-probe concurrency and per-target time
	// budget; the zero value is production-correct (see
	// cliinstall.ProbeOptions).
	ProbeOptions cliinstall.ProbeOptions
}

type ErrorMapper interface {
	// Failure maps a non-nil command error into the host's own error type:
	// a *UsageError, Plan's own batch-level *selfupdate.Failure (an unknown
	// name), Execute's own batch-level *selfupdate.Failure (no interactive
	// terminal and --yes not given), or a *cliinstall.BatchFailure carrying
	// every failed target's own typed *selfupdate.Failure
	// (cli-install#req:host-owned-exit-codes: "A batch failure MUST expose
	// each target's typed failure" — task-5 review S3). See
	// cliinstall.BatchFailure's own doc comment for the suggested
	// precedence a host applies when it wants one exit code for a batch
	// that failed for more than one reason.
	Failure(err error) error
}

type UpgradeErrorMapper interface {
	ErrorMapper
	// UpgradesAvailable is called with every target whose upgrade check
	// found one, mirroring self-update's own UpdateAvailable mapping.
	// Results is deliberately untyped for now ([]cliinstall.Result may not
	// be the shape upgrade's own check settles on) — this method exists so
	// the INTERFACE shape is reserved today; its real signature lands with
	// the upgrade command itself.
	UpgradesAvailable(results []cliinstall.Result) error
}

type UsageError struct{ Err error }