versionmap

Documentation

Index

• type DependencyVersionMap
  • func (m DependencyVersionMap) Add(dependencyName string, dependencyVersion *semver.Version, ...)
  • func (m DependencyVersionMap) FlatMap() ResolvedVersionMap
  • func (m DependencyVersionMap) GetDependencyTree(rootName string) treeprint.Tree
  • func (m DependencyVersionMap) GetDowngradedInOther(other DependencyVersionMap) DependencyVersionMap
  • func (m DependencyVersionMap) GetMissingFromOther(other DependencyVersionMap) DependencyVersionMap
  • func (m DependencyVersionMap) GetUpgradedInOther(other DependencyVersionMap) DependencyVersionMap
• type ResolvedVersionConstraint
  • func (c ResolvedVersionConstraint) Equals(other *ResolvedVersionConstraint) bool
  • func (c ResolvedVersionConstraint) IsPrerelease() bool
• type ResolvedVersionListMap
  • func (m ResolvedVersionListMap) Add(name string, versionConstraint *ResolvedVersionConstraint)
  • func (m ResolvedVersionListMap) FlatMap() map[string]*ResolvedVersionConstraint
  • func (m ResolvedVersionListMap) FlatNames() []string
  • func (m ResolvedVersionListMap) Remove(name string, constraint *ResolvedVersionConstraint)
• type ResolvedVersionMap
  • func (m ResolvedVersionMap) Add(name string, constraint *ResolvedVersionConstraint)
  • func (m ResolvedVersionMap) Remove(name string)
  • func (m ResolvedVersionMap) ToVersionListMap() ResolvedVersionListMap
• type VersionConstraintMap
• type VersionListMap
  • func (i VersionListMap) Add(name string, version *semver.Version)
  • func (m VersionListMap) FlatMap() map[string]bool
• type VersionMap
• type WorkspaceLock
  • func EmptyWorkspaceLock(existingLock *WorkspaceLock) *WorkspaceLock
  • func LoadWorkspaceLock(workspacePath string) (*WorkspaceLock, error)
  • func (l *WorkspaceLock) ContainsModConstraint(modName string, constraint *versionhelpers.Constraints) bool
  • func (l *WorkspaceLock) ContainsModVersion(modName string, modVersion *semver.Version) bool
  • func (l *WorkspaceLock) Delete() error
  • func (l *WorkspaceLock) DeleteMods(mods VersionConstraintMap, parent *modconfig.Mod)
  • func (l *WorkspaceLock) Empty() bool
  • func (l *WorkspaceLock) EnsureLockedModVersion(requiredModVersion *modconfig.ModVersionConstraint, parent *modconfig.Mod) (*ResolvedVersionConstraint, error)
  • func (l *WorkspaceLock) GetLockedModVersion(requiredModVersion *modconfig.ModVersionConstraint, parent *modconfig.Mod) (*ResolvedVersionConstraint, error)
  • func (l *WorkspaceLock) GetLockedModVersionConstraint(requiredModVersion *modconfig.ModVersionConstraint, parent *modconfig.Mod) (*modconfig.ModVersionConstraint, error)
  • func (l *WorkspaceLock) GetLockedModVersions(mods VersionConstraintMap, parent *modconfig.Mod) (ResolvedVersionListMap, error)
  • func (l *WorkspaceLock) GetMod(modName string, parent *modconfig.Mod) *ResolvedVersionConstraint
  • func (l *WorkspaceLock) GetModList(rootName string) string
  • func (l *WorkspaceLock) GetUnreferencedMods() VersionListMap
  • func (l *WorkspaceLock) Incomplete() bool
  • func (l *WorkspaceLock) Save() error

Types

type DependencyVersionMap

type DependencyVersionMap map[string]ResolvedVersionMap

func (DependencyVersionMap) Add

func (m DependencyVersionMap) Add(dependencyName string, dependencyVersion *semver.Version, constraintString string, parentName string)

Add adds a dependency to the list of items installed for the given parent

func (DependencyVersionMap) FlatMap

func (m DependencyVersionMap) FlatMap() ResolvedVersionMap

FlatMap converts the DependencyVersionMap into a ResolvedVersionMap, keyed by full name

func (DependencyVersionMap) GetDependencyTree

func (m DependencyVersionMap) GetDependencyTree(rootName string) treeprint.Tree

func (DependencyVersionMap) GetDowngradedInOther

func (m DependencyVersionMap) GetDowngradedInOther(other DependencyVersionMap) DependencyVersionMap

func (DependencyVersionMap) GetMissingFromOther

func (m DependencyVersionMap) GetMissingFromOther(other DependencyVersionMap) DependencyVersionMap

GetMissingFromOther returns a map of dependencies which exit in this map but not 'other'

func (DependencyVersionMap) GetUpgradedInOther

func (m DependencyVersionMap) GetUpgradedInOther(other DependencyVersionMap) DependencyVersionMap

type ResolvedVersionConstraint

type ResolvedVersionConstraint struct {
	Name string
	// Alias string
	Version    *semver.Version
	Constraint string
}

func (ResolvedVersionConstraint) Equals

func (c ResolvedVersionConstraint) Equals(other *ResolvedVersionConstraint) bool

func (ResolvedVersionConstraint) IsPrerelease

func (c ResolvedVersionConstraint) IsPrerelease() bool

type ResolvedVersionListMap

type ResolvedVersionListMap map[string][]*ResolvedVersionConstraint

ResolvedVersionListMap represents a map of ResolvedVersionConstraint arrays, keyed by dependency name

func (ResolvedVersionListMap) Add

func (m ResolvedVersionListMap) Add(name string, versionConstraint *ResolvedVersionConstraint)

Add appends the version constraint to the list for the given name

func (ResolvedVersionListMap) FlatMap

func (m ResolvedVersionListMap) FlatMap() map[string]*ResolvedVersionConstraint

FlatMap converts the ResolvedVersionListMap map into a map keyed by the FULL dependency name (i.e. including version(

func (ResolvedVersionListMap) FlatNames

func (m ResolvedVersionListMap) FlatNames() []string

FlatNames converts the ResolvedVersionListMap map into a string array of full names

func (ResolvedVersionListMap) Remove

func (m ResolvedVersionListMap) Remove(name string, constraint *ResolvedVersionConstraint)

Remove removes the given version constraint from the list for the given name

type ResolvedVersionMap

type ResolvedVersionMap map[string]*ResolvedVersionConstraint

ResolvedVersionMap represents a map of ResolvedVersionConstraint, keyed by dependency name

func (ResolvedVersionMap) Add

func (m ResolvedVersionMap) Add(name string, constraint *ResolvedVersionConstraint)

func (ResolvedVersionMap) Remove

func (m ResolvedVersionMap) Remove(name string)

func (ResolvedVersionMap) ToVersionListMap

func (m ResolvedVersionMap) ToVersionListMap() ResolvedVersionListMap

ToVersionListMap converts this map into a ResolvedVersionListMap

type VersionConstraintMap

type VersionConstraintMap map[string]*modconfig.ModVersionConstraint

type VersionListMap

type VersionListMap map[string]semver.Collection

VersionListMap is a map keyed by dependency name storing a list of versions for each dependency

func (VersionListMap) Add

func (i VersionListMap) Add(name string, version *semver.Version)

func (VersionListMap) FlatMap

func (m VersionListMap) FlatMap() map[string]bool

FlatMap converts the VersionListMap map into a bool map keyed by qualified dependency name

type VersionMap

type VersionMap map[string]*semver.Version

VersionMap represents a map of semver versions, keyed by dependency name

type WorkspaceLock

type WorkspaceLock struct {
	WorkspacePath   string
	InstallCache    DependencyVersionMap
	MissingVersions DependencyVersionMap

	ModInstallationPath string
	// contains filtered or unexported fields
}

WorkspaceLock is a map of ModVersionMaps items keyed by the parent mod whose dependencies are installed

func EmptyWorkspaceLock

func EmptyWorkspaceLock(existingLock *WorkspaceLock) *WorkspaceLock

EmptyWorkspaceLock creates a new empty workspace lock based, sharing workspace path and installedMods with 'existingLock'

func LoadWorkspaceLock

func LoadWorkspaceLock(workspacePath string) (*WorkspaceLock, error)

func (*WorkspaceLock) ContainsModConstraint

func (l *WorkspaceLock) ContainsModConstraint(modName string, constraint *versionhelpers.Constraints) bool

func (*WorkspaceLock) ContainsModVersion

func (l *WorkspaceLock) ContainsModVersion(modName string, modVersion *semver.Version) bool

ContainsModVersion returns whether the lockfile contains the given mod version

func (*WorkspaceLock) Delete

func (l *WorkspaceLock) Delete() error

Delete deletes the lock file

func (*WorkspaceLock) DeleteMods

func (l *WorkspaceLock) DeleteMods(mods VersionConstraintMap, parent *modconfig.Mod)

DeleteMods removes mods from the lock file then, if it is empty, deletes the file

func (*WorkspaceLock) Empty

func (l *WorkspaceLock) Empty() bool

Empty returns whether the install cache is empty

func (*WorkspaceLock) EnsureLockedModVersion

func (l *WorkspaceLock) EnsureLockedModVersion(requiredModVersion *modconfig.ModVersionConstraint, parent *modconfig.Mod) (*ResolvedVersionConstraint, error)

EnsureLockedModVersion looks for a lock file entry matching the required mod name

func (*WorkspaceLock) GetLockedModVersion

func (l *WorkspaceLock) GetLockedModVersion(requiredModVersion *modconfig.ModVersionConstraint, parent *modconfig.Mod) (*ResolvedVersionConstraint, error)

GetLockedModVersion looks for a lock file entry matching the required constraint and returns nil if not found

func (*WorkspaceLock) GetLockedModVersionConstraint

func (l *WorkspaceLock) GetLockedModVersionConstraint(requiredModVersion *modconfig.ModVersionConstraint, parent *modconfig.Mod) (*modconfig.ModVersionConstraint, error)

GetLockedModVersionConstraint looks for a lock file entry matching the required mod version and if found, returns it in the form of a ModVersionConstraint

func (*WorkspaceLock) GetLockedModVersions

func (l *WorkspaceLock) GetLockedModVersions(mods VersionConstraintMap, parent *modconfig.Mod) (ResolvedVersionListMap, error)

GetLockedModVersions builds a ResolvedVersionListMap with the resolved versions for each item of the given VersionConstraintMap found in the lock file

func (*WorkspaceLock) GetMod

func (l *WorkspaceLock) GetMod(modName string, parent *modconfig.Mod) *ResolvedVersionConstraint

GetMod looks for a lock file entry matching the given mod name

func (*WorkspaceLock) GetModList

func (l *WorkspaceLock) GetModList(rootName string) string

func (*WorkspaceLock) GetUnreferencedMods

func (l *WorkspaceLock) GetUnreferencedMods() VersionListMap

GetUnreferencedMods returns a map of all installed mods which are not in the lock file

func (*WorkspaceLock) Incomplete

func (l *WorkspaceLock) Incomplete() bool

Incomplete returned whether there are any missing dependencies (i.e. they exist in the lock file but ate not installed)

func (*WorkspaceLock) Save

func (l *WorkspaceLock) Save() error