parse

Documentation

Index

• type Function
  • func (f Function) TemplateName() string
  • func (f Function) TemplateString() string
• type PkgInfo
  • func Package(path string, files []string) (*PkgInfo, error)

Types

type Function

type Function struct {
	Name      string
	Receiver  string
	IsError   bool
	IsContext bool
	Synopsis  string
	Comment   string
}

Function represented a job function from a mage file

func (Function) TemplateName

func (f Function) TemplateName() string

TemplateName returns the invocation name, supporting namespaced functions.

func (Function) TemplateString

func (f Function) TemplateString() string

TemplateString returns code for the template switch to run the target. It wraps each target call to match the func(context.Context) error that runTarget requires.

type PkgInfo

type PkgInfo struct {
	Description      string
	Funcs            []Function
	DefaultIsError   bool
	DefaultIsContext bool
	DefaultName      string
	DefaultFunc      Function
	Aliases          map[string]string
}

PkgInfo contains inforamtion about a package of files according to mage's parsing rules.

func Package

func Package(path string, files []string) (*PkgInfo, error)

Package parses a package