goutil

Documentation

Index

• Constants
• Variables
• func BuildContext(mx *mg.Ctx) *build.Context
• func BuildContextWithoutCallbacks(mx *mg.Ctx) *build.Context
• func ClosestPkgDir(dir string) *vfs.Node
• func ClosestPkgDirNd(nd *vfs.Node) *vfs.Node
• func Dedent(s string) string
• func DedentCompletion(s string) string
• func HasImportPath(root, dir string) (importPath string, ok bool)
• func IdentAt(af *ast.File, pos token.Pos) *ast.Ident
• func IsLetter(ch rune) bool
• func IsPkgDir(dir string) bool
• func IsPkgDirNd(nd *vfs.Node) bool
• func ModEnabled(mx *mg.Ctx, srcDir string) bool
• func ModFileNd(mx *mg.Ctx, srcDir string) *vfs.Node
• func NodeEnclosesPos(node ast.Node, pos token.Pos) bool
• func PathList(p string) []string
• func PkgNdFilter(nd *vfs.Node) bool
• type ParsedFile
  • func ParseFile(mx *mg.Ctx, fn string, src []byte) *ParsedFile
  • func ParseFileWithMode(mx *mg.Ctx, fn string, src []byte, mode parser.Mode) *ParsedFile
• type PosEnd
  • func (pe PosEnd) End() token.Pos
  • func (pe PosEnd) Pos() token.Pos
• type ReleaseVersion
• type SrcDirKey
  • func MakeSrcDirKey(bctx *build.Context, srcDir string) SrcDirKey

Constants

const (
	ModEnvVar = "GO111MODULE"
)

const (
	ParseFileMode = parser.ParseComments | parser.DeclarationErrors | parser.AllErrors
)

Variables

var (
	NilPkgName    = "_"
	NilFset       = token.NewFileSet()
	NilPkgSrc     = "\n\npackage " + NilPkgName + "\n"
	NilAstFile, _ = parser.ParseFile(NilFset, "", NilPkgSrc, 0)
	NilTokenFile  = NilFset.File(NilAstFile.Pos())
)

var (
	VersionTag string         = build.Default.ReleaseTags[len(build.Default.ReleaseTags)-1]
	Version    ReleaseVersion = func() ReleaseVersion {
		s := strings.TrimPrefix(VersionTag, "go")
		l := strings.SplitN(s, ".", 2)
		v := ReleaseVersion{}
		v.Major, _ = strconv.Atoi(l[0])
		v.Minor, _ = strconv.Atoi(l[1])
		return v
	}()
)

var (
	// Langs is the list of all Go related langs
	Langs = []mg.Lang{mg.Go, mg.GoMod, mg.GoSum}
)

Functions

func BuildContext

func BuildContext(mx *mg.Ctx) *build.Context

func BuildContextWithoutCallbacks

func BuildContextWithoutCallbacks(mx *mg.Ctx) *build.Context

func ClosestPkgDir

func ClosestPkgDir(dir string) *vfs.Node

func ClosestPkgDirNd

func ClosestPkgDirNd(nd *vfs.Node) *vfs.Node

func Dedent

func Dedent(s string) string

Dedent un-indents tab-indented lines is s.

func DedentCompletion

func DedentCompletion(s string) string

DedentCompletion Dedents s then trims preceding and succeeding empty lines.

func HasImportPath

func HasImportPath(root, dir string) (importPath string, ok bool)

HasImportPath reports whether dir is lexically a subdirectory of root. If so, it sets importPath to a slash-separated path that can be joined to root to produce a path equivalent to dir.

HasImportPath is an implementation of go/build.Context.HasSubdir

func IdentAt

func IdentAt(af *ast.File, pos token.Pos) *ast.Ident

IdentAt returns the indentifier located at pos, if one exists.

func IsLetter

func IsLetter(ch rune) bool

func IsPkgDir

func IsPkgDir(dir string) bool

func IsPkgDirNd

func IsPkgDirNd(nd *vfs.Node) bool

func ModEnabled

func ModEnabled(mx *mg.Ctx, srcDir string) bool

ModEnabled returns true of Go modules are enabled in srcDir

func ModFileNd

func ModFileNd(mx *mg.Ctx, srcDir string) *vfs.Node

func NodeEnclosesPos

func NodeEnclosesPos(node ast.Node, pos token.Pos) bool

func PathList

func PathList(p string) []string

func PkgNdFilter

func PkgNdFilter(nd *vfs.Node) bool

Types

type ParsedFile

type ParsedFile struct {
	Fset      *token.FileSet
	AstFile   *ast.File
	TokenFile *token.File
	Error     error
	ErrorList scanner.ErrorList
}

func ParseFile

func ParseFile(mx *mg.Ctx, fn string, src []byte) *ParsedFile

func ParseFileWithMode

func ParseFileWithMode(mx *mg.Ctx, fn string, src []byte, mode parser.Mode) *ParsedFile

type PosEnd

type PosEnd struct {
	P token.Pos
	E token.Pos
}

func (PosEnd) End

func (pe PosEnd) End() token.Pos

func (PosEnd) Pos

func (pe PosEnd) Pos() token.Pos

type ReleaseVersion

type ReleaseVersion struct {
	Major int
	Minor int
}

type SrcDirKey

type SrcDirKey struct {
	GOROOT, GOPATH, SrcDir string
}

func MakeSrcDirKey

func MakeSrcDirKey(bctx *build.Context, srcDir string) SrcDirKey