plugin

type ClientVersion struct {
	Version Version
	// Known is false for a build whose version cannot be placed on the release
	// line at all — "dev", a Go pseudo-version, anything unparseable. Such a
	// build satisfies every bound, because refusing to run on an unknown
	// version would break every contributor's checkout.
	Known bool
}

type EnvVar struct {
	Name        string
	Description string
	// Required defaults to true: declaring a variable at all normally means the
	// plugin wants it.
	Required bool
}

type Finding struct {
	Severity Severity
	Field    string
	Line     int
	Message  string

	// Plugins names the plugins a finding concerns, so a surface can attribute
	// a collision to every side of it. Filtering on the message text instead
	// would break the first time a message was reworded.
	Plugins []string
}

type Layer string

type Manifest struct {
	Name        string
	Version     string
	Description string

	DisplayName string
	Homepage    string
	Maintainer  string
	License     string

	MinBuildmaxVersion string

	// Env is the declared environment contract, in file order.
	Env []EnvVar

	// Unknown lists top-level keys this build did not recognise, in file
	// order. They are kept rather than dropped so `plugin validate` can show a
	// misspelling that would otherwise be invisible.
	Unknown []string
}

type Origin struct {
	Layer Layer
	// Plugin is the plugin's name when Layer is LayerPlugin.
	Plugin string
	// Dir is the directory that was scanned.
	Dir string
}

type Provenance struct {
	Name   string `json:"name"`
	Source string `json:"source,omitempty"`

	RemoteURL string `json:"remote_url,omitempty"`
	Commit    string `json:"commit,omitempty"`
	Branch    string `json:"branch,omitempty"`
	// Dirty is a pointer so a clean checkout records false rather than
	// omitting the field: an absent flag reads as "nobody looked", and a
	// reader resolving that silence in the run's favour would credit it with
	// an immutable input it did not have.
	Dirty *bool `json:"dirty,omitempty"`

	MarketplaceServer string `json:"marketplace_server,omitempty"`
	CatalogID         string `json:"catalog_id,omitempty"`
	Version           string `json:"version,omitempty"`
	Digest            string `json:"digest,omitempty"`
}

type Severity int

type Shadowed struct {
	Name   string
	Winner Origin
	Loser  Origin
}

type Source struct {
	Dir    string
	Origin Origin
}

type Version struct {
	Major int
	Minor int
	Patch int
	// Pre holds prerelease identifiers, empty for a release version.
	Pre []string
}