mod_installer

package
v0.11.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 21, 2021 License: AGPL-3.0 Imports: 20 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	VerbInstalled   = "Installed"
	VerbUninstalled = "Uninstalled"
	VerbUpgraded    = "Upgraded"
	VerbDowngraded  = "Downgraded"
	VerbPruned      = "Pruned"
)

Variables

This section is empty.

Functions

func BuildInstallSummary added in v0.11.0 

func BuildInstallSummary(installData *InstallData) string

func BuildPruneSummary added in v0.11.0 

func BuildPruneSummary(pruned version_map.VersionListMap) string

func BuildUninstallSummary added in v0.11.0 

func BuildUninstallSummary(installData *InstallData) string

Types

type InstallData added in v0.11.0 

type InstallData struct {
	// record of the full dependency tree
	Lock    *version_map.WorkspaceLock
	NewLock *version_map.WorkspaceLock

	// list of dependencies installed by recent install operation
	Installed version_map.DependencyVersionMap
	// list of dependencies which have been upgraded
	Upgraded version_map.DependencyVersionMap
	// list of dependencies which have been downgraded
	Downgraded version_map.DependencyVersionMap
	// list of dependencies which have been uninstalled
	Uninstalled  version_map.DependencyVersionMap
	WorkspaceMod *modconfig.Mod
	// contains filtered or unexported fields
}

func InstallWorkspaceDependencies added in v0.11.0 

func InstallWorkspaceDependencies(opts *InstallOpts) (_ *InstallData, err error)

func NewInstallData added in v0.11.0 

func NewInstallData(workspaceLock *version_map.WorkspaceLock, workspaceMod *modconfig.Mod) *InstallData

func UninstallWorkspaceDependencies added in v0.11.0 

func UninstallWorkspaceDependencies(opts *InstallOpts) (*InstallData, error)

func (*InstallData) GetAvailableUpdates added in v0.11.0 

func (d *InstallData) GetAvailableUpdates() (version_map.DependencyVersionMap, error)

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

func (*InstallData) GetInstalledTree added in v0.11.0 

func (d *InstallData) GetInstalledTree() treeprint.Tree

func (*InstallData) GetUninstalledTree added in v0.11.0 

func (d *InstallData) GetUninstalledTree() treeprint.Tree

func (*InstallData) GetUpdatedTree added in v0.11.0 

func (d *InstallData) GetUpdatedTree() treeprint.Tree

type InstallOpts added in v0.11.0 

type InstallOpts struct {
	WorkspacePath string
	Command       string
	DryRun        bool
	ModArgs       []string
}

type ModInstaller 

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

func NewModInstaller 

func NewModInstaller(opts *InstallOpts) (*ModInstaller, error)

func (*ModInstaller) GetModList added in v0.11.0 

func (i *ModInstaller) GetModList() string

func (*ModInstaller) GetRequiredModVersionsFromArgs added in v0.11.0 

func (i *ModInstaller) GetRequiredModVersionsFromArgs(modsArgs []string) (version_map.VersionConstraintMap, error)

func (*ModInstaller) InstallWorkspaceDependencies added in v0.11.0 

func (i *ModInstaller) InstallWorkspaceDependencies() (err error)

InstallWorkspaceDependencies installs all dependencies of the workspace mod

func (*ModInstaller) Prune added in v0.11.0 

func (i *ModInstaller) Prune() (version_map.VersionListMap, error)

func (*ModInstaller) UninstallWorkspaceDependencies added in v0.11.0 

func (i *ModInstaller) UninstallWorkspaceDependencies() error

type ResolvedModRef 

type ResolvedModRef struct {
	// the FQN of the mod - also the Git URL of the mod repo
	Name string
	// the mod version
	Version *semver.Version
	// the vestion constraint
	Constraint *version_helpers.Constraints
	// the Git branch/tag
	GitReference plumbing.ReferenceName
	// the file path for local mods
	FilePath string
}

ResolvedModRef is a struct to represent a resolved mod git reference

func NewResolvedModRef 

func NewResolvedModRef(requiredModVersion *modconfig.ModVersionConstraint, version *semver.Version) (*ResolvedModRef, error)

func (*ResolvedModRef) FullName 

func (r *ResolvedModRef) FullName() string

FullName returns name in the format <dependency name>@v<dependencyVersion>

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.