gomod

README

gomod

load go mod util

mpkg, err := gomod.Load(dir)
pkg, dir, found := mpkg.Lookup(pkg)

Documentation

Index

• type Module
  • func (m *Module) String() string
• type ModuleError
• type Package
  • func Load(dir string, ctx *build.Context) (*Package, error)
  • func (p *Package) DepImportList(skipcmd bool, chkmodsub bool) (list []string)
  • func (p *Package) IsStd() bool
  • func (p *Package) LocalImportList(skipcmd bool) []string
  • func (p *Package) Lookup(pkg string) (path string, dir string, found bool)
  • func (p *Package) Root() *Module
• type PathPkgsIndex
  • func (p *PathPkgsIndex) LoadIndex(context build.Context, srcDirs ...string)
  • func (p *PathPkgsIndex) Sort()
• type PkgSlice
  • func (p PkgSlice) Len() int
  • func (p PkgSlice) Less(i, j int) bool
  • func (p PkgSlice) Swap(i, j int)
• type PkgsIndex

Types

type Module

type Module struct {
	Path      string       // module path
	Version   string       // module version
	Versions  []string     // available module versions (with -versions)
	Replace   *Module      // replaced by this module
	Time      *time.Time   // time version was created
	Update    *Module      // available update, if any (with -u)
	Main      bool         // is this the main module?
	Indirect  bool         // is this module only an indirect dependency of main module?
	Dir       string       // directory holding files for this module, if any
	GoMod     string       // path to go.mod file used when loading this module, if any
	GoVersion string       // go version used in module
	Retracted string       // retraction information, if any (with -retracted or -u)
	Error     *ModuleError // error loading module
}

func (*Module) String

func (m *Module) String() string

type ModuleError

type ModuleError struct {
	Err string // the error itself
}

type Package

type Package struct {
	List []*Module
	// contains filtered or unexported fields
}

func Load

func Load(dir string, ctx *build.Context) (*Package, error)

func (*Package) DepImportList

func (p *Package) DepImportList(skipcmd bool, chkmodsub bool) (list []string)

func (*Package) IsStd

func (p *Package) IsStd() bool

func (*Package) LocalImportList

func (p *Package) LocalImportList(skipcmd bool) []string

func (*Package) Lookup

func (p *Package) Lookup(pkg string) (path string, dir string, found bool)

func (*Package) Root

func (p *Package) Root() *Module

type PathPkgsIndex

type PathPkgsIndex struct {
	Indexs []*PkgsIndex
}

func (*PathPkgsIndex) LoadIndex

func (p *PathPkgsIndex) LoadIndex(context build.Context, srcDirs ...string)

func (*PathPkgsIndex) Sort

func (p *PathPkgsIndex) Sort()

type PkgSlice

type PkgSlice []*build.Package

func (PkgSlice) Len

func (p PkgSlice) Len() int

func (PkgSlice) Less

func (p PkgSlice) Less(i, j int) bool

func (PkgSlice) Swap

func (p PkgSlice) Swap(i, j int)

type PkgsIndex

type PkgsIndex struct {
	sync.Mutex
	Pkgs []*build.Package
}