mod

Documentation

Index

• Constants
• func AppendVersion(path, ver string) string
• func Config(m ModeType, goModopt GoModulesOptions, githubOpt GitHubOptions) error
• func ExtractVersion(path string) (newpath, ver string)
• func FileExists(fs afero.Fs, filename string, isDir bool) bool
• type DependencyManager
• type GitHubOptions
• type GoModulesOptions
• type Mode
• type ModeType
• type Module
  • func Retrieve(name string, ver string) (*Module, error)
• type Modules
  • func (m *Modules) Add(v *Module)
  • func (m *Modules) Len() int
• type NotFoundError
  • func (e *NotFoundError) Error() string
• type RateLimitError

Constants

const MasterBranch = "master"

const SHALength = 12

Functions

func AppendVersion

func AppendVersion(path, ver string) string

func Config

func Config(m ModeType, goModopt GoModulesOptions, githubOpt GitHubOptions) error

func ExtractVersion

func ExtractVersion(path string) (newpath, ver string)

func FileExists

func FileExists(fs afero.Fs, filename string, isDir bool) bool

Types

type DependencyManager

type DependencyManager interface {
	// Download external dependency to local directory
	Get(filename, ver string, m *Modules) (*Module, error)
	// Find dependency in m *Modules
	Find(filename, ver string, m *Modules) *Module
	// Load local cache into m *Modules
	Load(m *Modules) error
}

type GitHubOptions

type GitHubOptions struct {
	CacheDir    string
	AccessToken string
	Fs          afero.Fs
}

type GoModulesOptions

type GoModulesOptions struct {
	Root    string
	ModName string
}

type Mode

type Mode struct {
	sync.RWMutex
	// contains filtered or unexported fields
}

type ModeType

type ModeType string

const (
	GitHubMode    ModeType = "github"
	GoModulesMode ModeType = "go modules"
)

type Module

type Module struct {
	// The name of module joined by forward slash(/). e.g. "github.com/anz-bank/foo"
	Name string
	// The absolute path to the module.
	// e.g. "/Users/username/go/pkg/mod/github.com/anz-bank/foo@v1.1.0" on Linux and macOS
	//      "C:\Users\username\go\pkg\mod\github.com\anz-bank\foo@v1.1.0" on Windows
	Dir string
	// The version of the module. e.g. "v1.1.0"
	Version string
}

func Retrieve

func Retrieve(name string, ver string) (*Module, error)

type Modules

type Modules []*Module

func (*Modules) Add

func (m *Modules) Add(v *Module)

func (*Modules) Len

func (m *Modules) Len() int

type NotFoundError

type NotFoundError struct {
	Message string
}

func (*NotFoundError) Error

func (e *NotFoundError) Error() string

type RateLimitError

type RateLimitError = github.RateLimitError