modload

Documentation

Index

• Constants
• Variables
• type Module
  • func Create(dir string, modPath, goVer, gopVer string) (p Module, err error)
  • func Load(dir string) (p Module, err error)
  • func LoadFrom(gomod, gopmod string) (p Module, err error)
  • func LoadFromEx(gomod, gopmod string, readFile func(string) ([]byte, error)) (p Module, err error)
  • func (p Module) AddCompiler(compiler, ver string)
  • func (p Module) AddRequire(path, vers string, hasProj bool) error
  • func (p Module) DepMods() map[string]module.Version
  • func (p Module) HasModfile() bool
  • func (p Module) HasProject() bool
  • func (p Module) Modfile() string
  • func (p Module) Path() string
  • func (p Module) Projects() []*modfile.Project
  • func (p Module) Root() string
  • func (p Module) Save() (err error)
  • func (p Module) SaveWithGopMod(gop *env.Gop, flags int) (err error)

Constants

const (
	FlagDepModGop = 1 << iota // depends module github.com/goplus/gop
	FlagDepModX               // depends module github.com/qiniu/x
)

Variables

var (
	ErrNoModDecl   = errors.New("no module declaration in a .mod file")
	ErrNoModRoot   = errors.New("go.mod file not found in current directory or any parent directory")
	ErrSaveDefault = errors.New("attemp to save default project")
)

var Default = Module{
	File: &gomodfile.File{
		Module: &gomodfile.Module{},
		Go:     &gomodfile.Go{Version: defaultGoVer},
	},
	Opt: &modfile.File{
		Gop: &modfile.Gop{Version: defaultGopVer},
	},
}

Default represents the default gop.mod object.

Types

type Module

type Module struct {
	*gomodfile.File
	Opt *modfile.File
}

func Create

func Create(dir string, modPath, goVer, gopVer string) (p Module, err error)

Create creates a new module in `dir`. You should call `Save` manually to save this module.

func Load

func Load(dir string) (p Module, err error)

Load loads a module from specified directory.

func LoadFrom

func LoadFrom(gomod, gopmod string) (p Module, err error)

LoadFrom loads a module from specified go.mod file and an optional gop.mod file.

func LoadFromEx

func LoadFromEx(gomod, gopmod string, readFile func(string) ([]byte, error)) (p Module, err error)

LoadFromEx loads a module from specified go.mod file and an optional gop.mod file. It can specify a customized `readFile` to read file content.

func (Module) AddCompiler

func (p Module) AddCompiler(compiler, ver string)

AddCompiler adds a custom Go compiler to this module.

func (Module) AddRequire

func (p Module) AddRequire(path, vers string, hasProj bool) error

AddRequire adds a require package to this module.

func (Module) DepMods

func (p Module) DepMods() map[string]module.Version

DepMods returns all depended modules. If a depended module path is replace to be a local path, it will be canonical to an absolute path.

func (Module) HasModfile

func (p Module) HasModfile() bool

HasModfile returns if this module exists or not.

func (Module) HasProject

func (p Module) HasProject() bool

func (Module) Modfile

func (p Module) Modfile() string

Modfile returns absolute path of the module file.

func (Module) Path

func (p Module) Path() string

Path returns the module path.

func (Module) Projects

func (p Module) Projects() []*modfile.Project

func (Module) Root

func (p Module) Root() string

Root returns absolute root path of this module.

func (Module) Save

func (p Module) Save() (err error)

Save saves all changes of this module.

func (Module) SaveWithGopMod

func (p Module) SaveWithGopMod(gop *env.Gop, flags int) (err error)

SaveWithGopMod adds `require github.com/goplus/gop` and saves all changes of this module.