core

Documentation

Index

• 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) Execute() error
• type Project
  • func ParseProject(path string) (Project, error)
• type Query
  • func ParseQueries(qs []string) ([]Query, error)
• type Task
• type Workspace
  • func ParseWorkspace(cwd string) Workspace

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

ExecuteQuery executes the given query in the workspace

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

OsEnv returns current process environment as a map

func RenderTemplate

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

RenderTemplate renders the given template with env/args map

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
}

Execution represents a task and context being invoked

func (*Execution) Execute

func (e *Execution) Execute() error

Execute executes the current task

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
}

Project represents a parsed project

func ParseProject

func ParseProject(path string) (Project, error)

ParseProject parses the given project

type Query

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

Query reprents a task execution query

func ParseQueries

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

ParseQueries parses a query from the command line

type Task

type Task struct {
	Name       string
	Desc       string
	Cmd        string
	Before     string
	After      string
	Shell      string
	Retry      int
	RetryDelay time.Duration
}

Task reprents a parsed task

type Workspace

type Workspace struct {
	Cwd      string
	Projects []Project
}

Workspace represents the current myke workspace

func ParseWorkspace

func ParseWorkspace(cwd string) Workspace

ParseWorkspace parses the current workspace