margo

Documentation

Index

• func Configure(funcs ...func(*Opts))
• func FilterPath(path string) bool
• func FilterPathExt(path string) bool
• type ImportPathsFunc
• type Opts
  • func Options() Opts
• type PathFilterFunc

Functions

func Configure

func Configure(funcs ...func(*Opts))

Configure calls each func in funcs to configure the shared Opts

func FilterPath

func FilterPath(path string) bool

FilterPath returns true if path is *not* usually ignored by the Go tools (.*, _*, testdata)

func FilterPathExt

func FilterPathExt(path string) bool

FilterPathExt returns true if path does *not* have an extension *known* to be commonly found in Go projects

Types

type ImportPathsFunc

type ImportPathsFunc func(srcDir string, ctx *build.Context) map[string]string

ImportPathsFunc returns a map of package *import path* to title for display to the user

type Opts

type Opts struct {
	ImportPaths ImportPathsFunc
}

Opts contains options used by margo and its methods

func Options

func Options() Opts

Options returns a copy of the shared Opts

type PathFilterFunc

type PathFilterFunc func(path string) bool

PathFilterFunc returns true if path should not be ignore (when walking GOPATH, etc.)