dependency

type Client interface {
	// LocalCheck checks whether dependencies are in-sync locally
	//
	// Will return an error if the dependency cannot be found in the files it has defined, or if the version does not match
	LocalCheck(dependencyFilePath, basePath string) error

	// RemoteCheck checks whether dependencies are up to date with upstream
	//
	// Will return an error if checking the versions upstream fails.
	//
	// Out-of-date dependencies will be printed out on stdout at the INFO level.
	RemoteCheck(dependencyFilePath string) ([]string, error)

	// Upgrade retrieves the most up-to-date version of the dependency and replaces
	// the local version with the most up-to-date version.
	//
	// Will return an error if checking the versions upstream fails, or if updating
	// files fails.
	Upgrade(dependencyFilePath, basePath string) ([]string, error)

	SetVersion(dependencyFilePath, basePath, dependency, version string) error

	RemoteExport(dependencyFilePath string) ([]VersionUpdate, error)

	CheckUpstreamVersions(deps []*Dependency) ([]VersionUpdateInfo, error)
}

type Dependencies struct {
	Dependencies []*Dependency `yaml:"dependencies"`
}

type Dependency struct {
	Name string `yaml:"name"`
	// Version of the dependency that should be present throughout your code
	Version string `yaml:"version"`
	// Scheme for versioning this dependency
	Scheme VersionScheme `yaml:"scheme"`
	// Optional: sensitivity, to alert e.g. on new major versions
	Sensitivity VersionSensitivity `yaml:"sensitivity,omitempty"`
	// Optional: upstream
	Upstream map[string]string `yaml:"upstream,omitempty"`
	// List of references to this dependency in local files
	RefPaths []*RefPath `yaml:"refPaths"`
}

type LocalClient struct{}

type RefPath struct {
	// Path of the file to test
	Path string `yaml:"path"`
	// Match expression for the line that should contain the dependency's version. Regexp is supported.
	Match string `yaml:"match"`
}

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

type Version struct {
	Version string
	Scheme  VersionScheme
}

type VersionScheme string

type VersionSensitivity string

type VersionUpdate struct {
	Name       string `yaml:"name" json:"name"`
	Version    string `yaml:"version" json:"version"`
	NewVersion string `yaml:"new_version" json:"new_version"`
}

type VersionUpdateInfo struct {
	Name            string
	Current         Version
	Latest          Version
	UpdateAvailable bool
}