tools

type AddOptions struct {
	Name string
	Pkg  string // package path, optionally @version
	// NoFlush leaves the manifest alone and only returns the tool, for
	// callers (parallel sync, migrate) that merge and write it once at the end.
	NoFlush bool
	// Quiet drops the "Installing" and "Installed" lines and the @latest
	// pinning hint, for callers (upgrade) that report in their own words.
	// Warnings on the error stream are never suppressed.
	Quiet bool
	// RejectTwin refuses a tool that is already managed under another name
	// at the same version (any version in the unified strategy). Only an
	// explicit install asks for it: sync, migrate and init must still be able
	// to restore a manifest that already has such entries.
	RejectTwin bool
}

type Advisor interface {
	Warnings(ctx context.Context, dir, modulePath string) []string
}

type Config struct {
	Root     string          // the project root
	Layout   strategy.Layout // the strategy and tools directory
	Prefix   string          // the module path prefix for tool modules
	Store    Store
	Versions VersionResolver
	ModFiles modparser.Parser // modparser.XParser when nil
	Go       gocmd.Runner
	Network  gocmd.Runner // for network-bound calls; Go when nil
	Recorder Recorder     // no fingerprint is recorded when nil
	Advisor  Advisor      // no advice when nil
	Out, Err io.Writer    // discarded when nil
	Program  string       // the command name used in hints
}

type GoManager struct {
	// contains filtered or unexported fields
}

type Manager interface {
	// Add installs one tool and records it in the manifest (unless
	// o.NoFlush). It is all-or-nothing.
	Add(ctx context.Context, o AddOptions) (manifest.Tool, error)
	// Remove deletes one tool's files and manifest entry.
	Remove(ctx context.Context, name string) (RemoveResult, error)
	// Rename renames a tool's files and manifest entry, undoing every step if
	// a later one fails.
	Rename(ctx context.Context, oldName, newName string, o RenameOptions) error
	// Upgrade moves one tool to @latest and records it.
	Upgrade(ctx context.Context, from manifest.Tool) (manifest.Tool, error)
	// Restore reinstalls tools at the versions the manifest pins,
	// concurrently where the strategy allows.
	Restore(ctx context.Context, tools []manifest.Tool, o RestoreOptions) error
}

type Recorder interface {
	Record(ctx context.Context) error
}

type RemoveResult struct {
	OnDisk     bool // files on disk served the tool, and were removed
	InManifest bool // the manifest listed the tool, and no longer does
}

type RenameOptions struct {
	// DryRun runs every precondition check and reports the rename without
	// touching disk.
	DryRun bool
}

type RestoreOptions struct {
	// Jobs is how many tools install at once (split and module only). Values
	// below 2 install one after the other.
	Jobs int
}

type Store interface {
	// Manifest is the in-memory manifest. Operations change it and call Flush.
	Manifest() *manifest.Manifest
	// Flush writes the manifest to disk.
	Flush() error
}

type VersionResolver interface {
	Resolve(ctx context.Context) (string, error)
}