gomod

Documentation

Index

• type GoMod
  • func (g *GoMod) LoadAndComputePairs(filename string) ([]libyear.Pair, error)
• type Queryer
  • func (q *Queryer) GetLatestVersion(module string) libyear.Info
  • func (q *Queryer) GetVersion(module string, version string) libyear.Info

Types

type GoMod

type GoMod struct {
	IncludeIndirect bool
	ProxyLoader     Queryer
	Logger          logger
}

GoMod represents a Go Modules parser. Running LoadAndComputePairs with a filename will return a slice of parsed dependencies.

func (*GoMod) LoadAndComputePairs

func (g *GoMod) LoadAndComputePairs(filename string) ([]libyear.Pair, error)

LoadAndComputePairs takes a filename of a go.mod file, runs the resolution algorithm in the provided Querier, and returns parsed pairs of dependencies and their latest versions.

type Queryer

type Queryer struct {
	Root   string
	Client http.Client
	Cache  cache.Cache
	Logger logger
}

A Queryer holds settings for a

func (*Queryer) GetLatestVersion

func (q *Queryer) GetLatestVersion(module string) libyear.Info

GetLatestVersion returns the "latest" major version of a module, jumping across MVS boundaries: i.e. github.com/foo/bar => github.com/foo/bar/v2 in the case of one version bump github.com/foo/baz/v2 => github.com/foo/baz/v6 in the case of a large jump github.com/foo/quuz/v2 => github.com/foo/quuz/v2 in the case of no jump at all.

func (*Queryer) GetVersion

func (q *Queryer) GetVersion(module string, version string) libyear.Info

GetVersion returns the proxy's information about a given version of a module. `module` in this case is a fully-disambiguated MVS name (github.com/foo/bar/v2), and `version` is a version identifier as defined in `https://blog.golang.org/publishing-go-modules#TOC_3.`