modinstaller

Documentation

Index

• Constants
• func BuildInstallSummary(installData *InstallData) string
• func BuildPruneSummary(pruned versionmap.VersionListMap) string
• func BuildUninstallSummary(installData *InstallData) string
• func ValidateModLocation(ctx context.Context, workspacePath string) bool
• type ByteSequence
  • func NewByteSequence(b []byte) *ByteSequence
  • func (bseq *ByteSequence) Apply(apply func([]byte) []byte)
  • func (b *ByteSequence) ApplyChanges(changeSet ChangeSet)
  • func (bseq *ByteSequence) Bytes() []byte
• type Change
• type ChangeOperation
• type ChangeSet
  • func EmptyChangeSet() ChangeSet
  • func MergeChangeSet(changeSets ...ChangeSet) ChangeSet
  • func NewChangeSet(changes ...*Change) ChangeSet
  • func (c ChangeSet) SortByOffset()
• type GitUrlMode
  • func (e *GitUrlMode) Set(v string) error
  • func (e *GitUrlMode) String() string
  • func (e *GitUrlMode) Type() string
• type InstallData
  • func InstallWorkspaceDependencies(ctx context.Context, opts *InstallOpts) (_ *InstallData, err error)
  • func NewInstallData(workspaceLock *versionmap.WorkspaceLock, workspaceMod *modconfig.Mod, ...) *InstallData
  • func (d *InstallData) GetAvailableUpdates() (versionmap.DependencyVersionMap, error)
  • func (d *InstallData) GetInstalledTree() treeprint.Tree
  • func (d *InstallData) GetUninstalledTree() treeprint.Tree
  • func (d *InstallData) GetUpdatedTree() treeprint.Tree
• type InstallOpts
  • func NewInstallOpts(workspaceMod *modconfig.Mod, modsToInstall ...string) *InstallOpts
• type ModInstaller
  • func NewModInstaller(opts *InstallOpts) (*ModInstaller, error)
  • func (i *ModInstaller) GetModList() string
  • func (i *ModInstaller) GetRequiredModVersionsFromArgs(modsArgs []string) (versionmap.VersionConstraintMap, error)
  • func (i *ModInstaller) InstallWorkspaceDependencies(ctx context.Context) (err error)
  • func (i *ModInstaller) Prune() (versionmap.VersionListMap, error)
  • func (i *ModInstaller) UninstallWorkspaceDependencies(ctx context.Context) error
• type OperatorFunc
• type ResolvedModRef
  • func NewResolvedModRef(requiredModVersion *modconfig.ModVersionConstraint, version *semver.Version) (*ResolvedModRef, error)
  • func (r *ResolvedModRef) DependencyPath() string

Constants

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

Functions

func BuildInstallSummary

func BuildInstallSummary(installData *InstallData) string

func BuildPruneSummary

func BuildPruneSummary(pruned versionmap.VersionListMap) string

func BuildUninstallSummary

func BuildUninstallSummary(installData *InstallData) string

func ValidateModLocation

func ValidateModLocation(ctx context.Context, workspacePath string) bool

ValidateModLocation checks whether you are running from the home directory or if you have a lot of non .sql and .sp file in your current directory, and asks for confirmation to continue

Types

type ByteSequence

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

func NewByteSequence

func NewByteSequence(b []byte) *ByteSequence

func (*ByteSequence) Apply

func (bseq *ByteSequence) Apply(apply func([]byte) []byte)

Apply applies the given function on the byte sequence

func (*ByteSequence) ApplyChanges

func (b *ByteSequence) ApplyChanges(changeSet ChangeSet)

func (*ByteSequence) Bytes

func (bseq *ByteSequence) Bytes() []byte

Bytes returns the current underlying byte sequence

type Change

type Change struct {
	Content     []byte
	Operation   ChangeOperation
	OffsetStart int
	OffsetEnd   int
}

type ChangeOperation

type ChangeOperation int

const (
	Insert ChangeOperation = iota
	Delete
	Replace
)

type ChangeSet

type ChangeSet []*Change

func EmptyChangeSet

func EmptyChangeSet() ChangeSet

func MergeChangeSet

func MergeChangeSet(changeSets ...ChangeSet) ChangeSet

MergeChangeSet creates a ChangeSet by merging the given ChangeSets in order

func NewChangeSet

func NewChangeSet(changes ...*Change) ChangeSet

NewChangeSet creates a ChangeSet from the given changes

func (ChangeSet) SortByOffset

func (c ChangeSet) SortByOffset()

type GitUrlMode

type GitUrlMode string

const (
	GitUrlModeHTTPS GitUrlMode = "https"
	GitUrlModeSSH   GitUrlMode = "ssh"
)

func (*GitUrlMode) Set

func (e *GitUrlMode) Set(v string) error

Set must have pointer receiver so it doesn't change the value of a copy

func (*GitUrlMode) String

func (e *GitUrlMode) String() string

String is used both by fmt.Print and by Cobra in help text

func (*GitUrlMode) Type

func (e *GitUrlMode) Type() string

Type is only used in help text

type InstallData

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

	// list of dependencies installed by recent install operation
	Installed versionmap.DependencyVersionMap
	// list of dependencies which have been upgraded
	Upgraded versionmap.DependencyVersionMap
	// list of dependencies which have been downgraded
	Downgraded versionmap.DependencyVersionMap
	// list of dependencies which have been uninstalled
	Uninstalled  versionmap.DependencyVersionMap
	WorkspaceMod *modconfig.Mod

	GitUrlMode GitUrlMode
	// contains filtered or unexported fields
}

func InstallWorkspaceDependencies

func InstallWorkspaceDependencies(ctx context.Context, opts *InstallOpts) (_ *InstallData, err error)

func NewInstallData

func NewInstallData(workspaceLock *versionmap.WorkspaceLock, workspaceMod *modconfig.Mod, urlMode GitUrlMode) *InstallData

func (*InstallData) GetAvailableUpdates

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

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

func (*InstallData) GetInstalledTree

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

func (*InstallData) GetUninstalledTree

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

func (*InstallData) GetUpdatedTree

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

type InstallOpts

type InstallOpts struct {
	WorkspaceMod *modconfig.Mod
	Command      string
	ModArgs      []string
	DryRun       bool
	Force        bool
	GitUrlMode   GitUrlMode
}

func NewInstallOpts

func NewInstallOpts(workspaceMod *modconfig.Mod, modsToInstall ...string) *InstallOpts

type ModInstaller

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

func NewModInstaller

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

func (*ModInstaller) GetModList

func (i *ModInstaller) GetModList() string

func (*ModInstaller) GetRequiredModVersionsFromArgs

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

func (*ModInstaller) InstallWorkspaceDependencies

func (i *ModInstaller) InstallWorkspaceDependencies(ctx context.Context) (err error)

InstallWorkspaceDependencies installs all dependencies of the workspace mod

func (*ModInstaller) Prune

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

func (*ModInstaller) UninstallWorkspaceDependencies

func (i *ModInstaller) UninstallWorkspaceDependencies(ctx context.Context) error

type OperatorFunc

type OperatorFunc func(*Change, []byte) []byte

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 *versionhelpers.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) DependencyPath

func (r *ResolvedModRef) DependencyPath() string

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