core

Documentation

Index

• Constants
• func Asset(name string) ([]byte, error)
• func AssetDir(name string) ([]string, error)
• func AssetInfo(name string) (os.FileInfo, error)
• func AssetNames() []string
• func ExecuteQuery(w *Workspace, q Query) error
• func MustAsset(name string) []byte
• func OsEnv() map[string]string
• func RenderTemplate(tmpl string, env map[string]string, args map[string]string) (string, error)
• func RestoreAsset(dir, name string) error
• func RestoreAssets(dir, name string) error
• type Execution
  • func (e *Execution) Env() map[string]string
  • func (e *Execution) EnvList() []string
  • func (e *Execution) Execute() error
  • func (e *Execution) ExecuteDependent(qs []string) error
  • func (e *Execution) ExecuteSelf() error
• type Project
  • func ParseProject(path string) (Project, error)
• type Query
  • func ParseQueries(qs []string) ([]Query, error)
  • func ParseQuery(q string) (Query, error)
  • func (q *Query) Match(p *Project, t *Task) bool
  • func (q *Query) Search(w *Workspace) []QueryMatch
• type QueryMatch
• type Task
• type Workspace
  • func ParseWorkspace(cwd string) Workspace

Constants

const PathSep = string(os.PathListSeparator)

Functions

func Asset

func Asset(name string) ([]byte, error)

Asset loads and returns the asset for the given name. It returns an error if the asset could not be found or could not be loaded.

func AssetDir

func AssetDir(name string) ([]string, error)

AssetDir returns the file names below a certain directory embedded in the file by go-bindata. For example if you run go-bindata on data/... and data contains the following hierarchy:

data/
  foo.txt
  img/
    a.png
    b.png

then AssetDir("data") would return []string{"foo.txt", "img"} AssetDir("data/img") would return []string{"a.png", "b.png"} AssetDir("foo.txt") and AssetDir("notexist") would return an error AssetDir("") will return []string{"data"}.

func AssetInfo

func AssetInfo(name string) (os.FileInfo, error)

AssetInfo loads and returns the asset info for the given name. It returns an error if the asset could not be found or could not be loaded.

func AssetNames

func AssetNames() []string

AssetNames returns the names of the assets.

func ExecuteQuery

func ExecuteQuery(w *Workspace, q Query) error

func MustAsset

func MustAsset(name string) []byte

MustAsset is like Asset but panics when Asset would return an error. It simplifies safe initialization of global variables.

func OsEnv

func OsEnv() map[string]string

func RenderTemplate

func RenderTemplate(tmpl string, env map[string]string, args map[string]string) (string, error)

func RestoreAsset

func RestoreAsset(dir, name string) error

RestoreAsset restores an asset under the given directory

func RestoreAssets

func RestoreAssets(dir, name string) error

RestoreAssets restores an asset under the given directory recursively

Types

type Execution

type Execution struct {
	Workspace *Workspace
	Query     *Query
	Project   *Project
	Task      *Task
}

func (*Execution) Env

func (e *Execution) Env() map[string]string

func (*Execution) EnvList

func (e *Execution) EnvList() []string

func (*Execution) Execute

func (e *Execution) Execute() error

func (*Execution) ExecuteDependent

func (e *Execution) ExecuteDependent(qs []string) error

func (*Execution) ExecuteSelf

func (e *Execution) ExecuteSelf() error

type Project

type Project struct {
	Src      string
	Cwd      string
	Name     string
	Desc     string
	Tags     []string
	Discover []string
	Mixin    []string
	Env      map[string]string
	EnvFiles []string
	Tasks    map[string]Task
}

func ParseProject

func ParseProject(path string) (Project, error)

type Query

type Query struct {
	Raw    string
	Task   string
	Tags   []string
	Params map[string]string
}

func ParseQueries

func ParseQueries(qs []string) ([]Query, error)

func ParseQuery

func ParseQuery(q string) (Query, error)

func (*Query) Match

func (q *Query) Match(p *Project, t *Task) bool

func (*Query) Search

func (q *Query) Search(w *Workspace) []QueryMatch

type QueryMatch

type QueryMatch struct {
	Project Project
	Task    Task
}

type Task

type Task struct {
	Name   string
	Desc   string
	Cmd    string
	Before []string
	After  []string
}

type Workspace

type Workspace struct {
	Cwd      string
	Projects []Project
}

func ParseWorkspace

func ParseWorkspace(cwd string) Workspace