engws

type BumpResult struct {
	Module      string // dependency model module path
	From, To    string
	GoModule    string // Go module required, empty when not changed
	LockWritten bool
	Diagnostics []validate.Diagnostic
}

type CheckOptions struct {
	// InProcess forces the library check even when a repo pins its own.
	InProcess bool
	// Jobs bounds the concurrent exec checks; 0 means GOMAXPROCS.
	Jobs int
	// Refresh re-fetches every registry dependency instead of reusing the
	// module cache (ENGMOD_MODULE_CACHE=refresh), so a moved tag is seen.
	Refresh bool
}

type CheckResult struct {
	Target   CheckTarget
	Method   string // exec: the repo's pinned .github/engmod-check; library: in-process
	Errors   int
	Warnings int
	Lines    []string // error lines and other failure output
	Failed   bool
}

type CheckTarget struct {
	Entry  Entry
	Reason string // local, depends on <checkout>, top system
}

type Checkout struct {
	Name     string // directory name under the root
	Dir      string // absolute directory
	Manifest model.ManifestDocument
	GoModule string // module path from go.mod, empty without go.mod
	// GoRequires maps each module path required in go.mod to its version.
	GoRequires map[string]string
}

type Entry struct {
	Checkout
	Pinned  bool
	Reasons []string // why the checkout is changed, in detection order
	State   string
	Local   bool // listed as a replacement
	Note    string
}

type Plan struct {
	Root    string
	Entries []Entry
	Notes   []string
	// Warnings name the checkouts Scan skipped as unsafe.
	Warnings []string
}

type Publication int

type Registry interface {
	// Published reports the publication of modulePath (with @vN) at version
	// and, for PublicationUnknown, why.
	Published(ctx context.Context, modulePath, version string) (Publication, string)
}

type Skew struct {
	Consumer, Alias, Module, Pinned, LocalCheckout, LocalVersion string
}

type StageResult struct {
	Root        string
	RegistryDir string
	GoProxyDir  string
	Modules     []StagedModule // in dependency order
	Warnings    []string
	// Failures name the checkouts that cannot be staged; when any exist
	// nothing is written.
	Failures []string
}

type StagedModule struct {
	Name       string // checkout directory name
	ModulePath string // CUE module path with major version
	Version    string
	CUEFiles   int
	LayoutDir  string // OCI image layout of the CUE module
	GoModule   string // staged Go module path, empty without go.mod
	Notes      []string
}

type SyncResult struct {
	WorkFile      string
	GoWork        string // written go.work, empty when none
	GoWorkRemoved bool
}