mod

Documentation

Index

• type LockFile
• type Mod
  • func New(storage Storage, moduleConfig ModuleConfig, lockFile LockFile) *Mod
  • func (c *Mod) Download(ctx context.Context, dependencies []string) error
  • func (c *Mod) Get(ctx context.Context, requestedModule models.Module) error
  • func (c *Mod) Update(ctx context.Context, dependencies []string) error
• type ModuleConfig
• type Storage

Types

type LockFile

type LockFile interface {
	Read(moduleName string) (models.LockFileInfo, error)
	Write(
		moduleName string, revisionVersion string, installedPackageHash models.ModuleHash,
	) error
}

LockFile should implement adapter for lock file workflow

type Mod

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

Mod implement package manager's commands

func New

func New(storage Storage, moduleConfig ModuleConfig, lockFile LockFile) *Mod

func (*Mod) Download

func (c *Mod) Download(ctx context.Context, dependencies []string) error

Download all packages from config dependencies slice of strings format: origin@version: github.com/company/repository@v1.2.3 if version is absent use the latest commit

func (*Mod) Get

func (c *Mod) Get(ctx context.Context, requestedModule models.Module) error

Get download package.

func (*Mod) Update

func (c *Mod) Update(ctx context.Context, dependencies []string) error

Update all packages from config dependencies slice of strings format: origin@version: github.com/company/repository@v1.2.3 if version is absent use the latest commit

type ModuleConfig

type ModuleConfig interface {
	ReadFromRepo(ctx context.Context, repo repository.Repo, revision models.Revision) (models.ModuleConfig, error)
}

ModuleConfig should implement adapter for reading module configs

type Storage

type Storage interface {
	CreateCacheRepositoryDir(name string) (string, error)
	CreateCacheDownloadDir(models.CacheDownloadPaths) error
	GetCacheDownloadPaths(module models.Module, revision models.Revision) models.CacheDownloadPaths
	Install(
		cacheDownloadPaths models.CacheDownloadPaths,
		module models.Module,
		revision models.Revision,
		moduleConfig models.ModuleConfig,
	) (models.ModuleHash, error)
	GetInstalledModuleHash(moduleName string, revisionVersion string) (models.ModuleHash, error)
	IsModuleInstalled(module models.Module) (bool, error)
}

Storage should implement workflow with storage adapter