cmdkit

type CheckedOutput struct {
	// Out is the stdout the writes go to.
	Out io.Writer
	// Err is why the first write that failed could not be made, an
	// ErrOutputUnwritten, or nil while none has.
	Err error
}

type Connection struct {
	// Config is the configuration in effect.
	Config config.Config
	// LoadErr is why the configuration did not load — config.ErrNotFound
	// when there is no file — or nil.
	LoadErr error
	// Where is the repository the command runs in, or the directory when
	// there is none.
	Where wiring.Workspace
	// Deps are the seams over the configuration and the repository.
	Deps tui.Deps
	// Controls are the wiring's own: finding tokens ahead, and applying
	// settings the web's Settings saves.
	Controls wiring.Controls
	// RequestLog records each request, or is nil; a switch wires the next
	// directory to the same log.
	RequestLog *wiring.RequestLog
	// CloseLog closes the request log, which the caller defers.
	CloseLog func()
	// Keychain keeps a token typed into the first run's form in the OS
	// keychain; nil where none is wired, or under a dry run.
	Keychain func(ctx context.Context, service, secret string) error
	// Process is what the wiring read of the process: the home, variables,
	// store and programs the command runs with.
	Process wiring.Environment
}

type Environment struct {
	// WorkingDir is the directory the command was run from, or why the
	// operating system cannot name it. A command reads it once, whatever
	// reads it after: its sections, its request log and each directory it
	// names relatively are all read from the one directory.
	WorkingDir func() (string, error)
	// Chdir makes dir the process's working directory, so whatever a session
	// switched there runs — an editor, a hook — starts there.
	Chdir func(dir string) error
	// Process is what the wiring reads of the process.
	Process wiring.Environment
}

type Output struct {
	// Artifact is where the artifact goes: stdout, or the notes' own stream
	// for an aside.
	Artifact io.Writer
	// Notes are what the command says about it, on stderr.
	Notes console.Notes
}

type Prompt struct {
	// Line prints prompt and reads one visible line, for an address or a choice.
	Line func(prompt string) (string, error)
	// Secret prints prompt and reads one line without echoing it, for a token;
	// with no terminal to read it from, it answers io.EOF.
	Secret func(prompt string) (string, error)
	// StoreSecret saves secret in the OS keychain under the item service names,
	// under ctx. It is nil where storing is not wired for the platform, and the
	// guided flow then keeps the token in the file.
	StoreSecret func(ctx context.Context, service, secret string) error
	// Input is standard input, read to its end for a comment's text, as `git
	// commit -F -` reads a message, so a script never quotes it. It shares Line's
	// reader, so nothing read for one is lost to the other. Nil reads as empty.
	Input io.Reader
	// IsTerminal reports whether a stream is a terminal, so a slow command keeps
	// a live line on stderr only where a person is watching it, never in a
	// pipe or a log, and prints its artifact beside the line only where stdout
	// is no terminal. Nil reads every stream as no terminal.
	IsTerminal func(stream io.Writer) bool
}

type RootFlags struct {
	// DryRun is --dry-run: show what would change, and change nothing.
	DryRun bool
	// Web is --web: serve the web app rather than open the interface.
	Web bool
	// Port is --port, the port --web serves on.
	Port int
}

type WriteOptions struct {
	// DryRun is a run that changes nothing.
	DryRun bool
	// Yes skips the confirmation.
	Yes bool
}

type WritePrompt struct {
	// Question is what the confirmation asks.
	Question string
	// DryRun is what a dry run says the write would do.
	DryRun string
	// Declined is what the write prints when the answer is no.
	Declined string
}