core

Documentation

Overview

Package core is generated by github.com/omeid/go-resources

Index

• func ExecuteQuery(w *Workspace, q Query, dryRun bool, verbose int) error
• func OsEnv() map[string]string
• func RenderTemplate(tmpl string, env map[string]string, args map[string]string) (string, error)
• type Execution
  • func (e *Execution) Execute() error
• type File
  • func (f *File) Close() error
  • func (f *File) Readdir(count int) ([]os.FileInfo, error)
  • func (f *File) Stat() (os.FileInfo, error)
• type FileInfo
  • func (f *FileInfo) IsDir() bool
  • func (f *FileInfo) ModTime() time.Time
  • func (f *FileInfo) Mode() os.FileMode
  • func (f *FileInfo) Name() string
  • func (f *FileInfo) Readdir(count int) ([]os.FileInfo, error)
  • func (f *FileInfo) Size() int64
  • func (f *FileInfo) Sys() interface{}
• type FileSystem
  • func (fs *FileSystem) Open(name string) (http.File, error)
  • func (fs *FileSystem) String(name string) (string, bool)
• type Project
  • func ParseProject(path string) (Project, error)
• type Query
  • func ParseQueries(qs []string) []Query
• type Task
• type Workspace
  • func ParseWorkspace(cwd string) (Workspace, error)

Functions

func ExecuteQuery

func ExecuteQuery(w *Workspace, q Query, dryRun bool, verbose int) error

ExecuteQuery executes the given query in the workspace

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

Types

type Execution

type Execution struct {
	Workspace *Workspace
	Query     *Query
	Project   *Project
	Task      *Task
	DryRun    bool
	Verbose   int
}

Execution represents a task and context being invoked

func (*Execution) Execute

func (e *Execution) Execute() error

Execute executes the current task

type File

type File struct {
	*bytes.Reader
	// contains filtered or unexported fields
}

File implements http.File

func (*File) Close

func (f *File) Close() error

Close is a noop-closer.

func (*File) Readdir

func (f *File) Readdir(count int) ([]os.FileInfo, error)

Readdir implements http.File.Readdir

func (*File) Stat

func (f *File) Stat() (os.FileInfo, error)

Stat implements http.Stat.Readdir

type FileInfo

type FileInfo struct {
	// contains filtered or unexported fields
}

FileInfo implements the os.FileInfo interface.

func (*FileInfo) IsDir

func (f *FileInfo) IsDir() bool

IsDir implements os.FileInfo.IsDir

func (*FileInfo) ModTime

func (f *FileInfo) ModTime() time.Time

ModTime implements os.FileInfo.ModTime

func (*FileInfo) Mode

func (f *FileInfo) Mode() os.FileMode

Mode implements os.FileInfo.Mode

func (*FileInfo) Name

func (f *FileInfo) Name() string

Name implements os.FileInfo.Name

func (*FileInfo) Readdir

func (f *FileInfo) Readdir(count int) ([]os.FileInfo, error)

Readdir implements os.FileInfo.Readdir

func (*FileInfo) Size

func (f *FileInfo) Size() int64

Size implements os.FileInfo.Size

func (*FileInfo) Sys

func (f *FileInfo) Sys() interface{}

Sys returns the underlying value.

type FileSystem

type FileSystem struct {
	// contains filtered or unexported fields
}

FileSystem is an http.FileSystem implementation.

var FS *FileSystem

func (*FileSystem) Open

func (fs *FileSystem) Open(name string) (http.File, error)

Open implements http.FileSystem.Open

func (*FileSystem) String

func (fs *FileSystem) String(name string) (string, bool)

String returns the content of the file as string.

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

ParseQueries parses a query from the command line

type Task

type Task struct {
	Name       string
	Desc       string
	Cmd        string
	Before     string
	After      string
	Error      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, error)

ParseWorkspace parses the current workspace