taskfile

Documentation

Index

• Constants
• Variables
• func Merge(t1, t2 *Taskfile, includedTaskfile *IncludedTaskfile, namespaces ...string) error
• type Call
• type Cmd
  • func (c *Cmd) UnmarshalYAML(unmarshal func(interface{}) error) error
• type Dep
  • func (d *Dep) UnmarshalYAML(unmarshal func(interface{}) error) error
• type IncludedTaskfile
  • func (it *IncludedTaskfile) DeepCopy() *IncludedTaskfile
  • func (it *IncludedTaskfile) FullDirPath() (string, error)
  • func (it *IncludedTaskfile) FullTaskfilePath() (string, error)
  • func (it *IncludedTaskfile) UnmarshalYAML(unmarshal func(interface{}) error) error
• type IncludedTaskfiles
  • func (tfs *IncludedTaskfiles) Len() int
  • func (tfs *IncludedTaskfiles) Merge(other *IncludedTaskfiles)
  • func (tfs *IncludedTaskfiles) Range(yield func(key string, includedTaskfile IncludedTaskfile) error) error
  • func (tfs *IncludedTaskfiles) Set(key string, includedTaskfile IncludedTaskfile)
  • func (tfs *IncludedTaskfiles) UnmarshalYAML(node *yaml.Node) error
• type Output
  • func (s *Output) IsSet() bool
  • func (s *Output) UnmarshalYAML(unmarshal func(interface{}) error) error
• type OutputGroup
  • func (g *OutputGroup) IsSet() bool
• type Precondition
  • func (p *Precondition) UnmarshalYAML(unmarshal func(interface{}) error) error
• type Task
  • func (t *Task) DeepCopy() *Task
  • func (t *Task) Name() string
  • func (t *Task) UnmarshalYAML(unmarshal func(interface{}) error) error
• type Taskfile
  • func (tf *Taskfile) ParsedVersion() (float64, error)
  • func (tf *Taskfile) UnmarshalYAML(unmarshal func(interface{}) error) error
• type Tasks
• type Var
  • func (v *Var) UnmarshalYAML(unmarshal func(interface{}) error) error
• type Vars
  • func (vs *Vars) DeepCopy() *Vars
  • func (vs *Vars) Len() int
  • func (vs *Vars) Merge(other *Vars)
  • func (vs *Vars) Range(yield func(key string, value Var) error) error
  • func (vs *Vars) Set(key string, value Var)
  • func (vs *Vars) ToCacheMap() (m map[string]interface{})
  • func (vs *Vars) UnmarshalYAML(node *yaml.Node) error

Constants

const NamespaceSeparator = ":"

NamespaceSeparator contains the character that separates namescapes

Variables

var (
	// ErrCantUnmarshalPrecondition is returned for invalid precond YAML.
	ErrCantUnmarshalPrecondition = errors.New("task: Can't unmarshal precondition value")
)

Functions

func Merge

func Merge(t1, t2 *Taskfile, includedTaskfile *IncludedTaskfile, namespaces ...string) error

Merge merges the second Taskfile into the first

Types

type Call

type Call struct {
	Task string
	Vars *Vars
}

Call is the parameters to a task call

type Cmd

type Cmd struct {
	Cmd         string
	Silent      bool
	Task        string
	Vars        *Vars
	IgnoreError bool
	Defer       bool
}

Cmd is a task command

func (*Cmd) UnmarshalYAML

func (c *Cmd) UnmarshalYAML(unmarshal func(interface{}) error) error

UnmarshalYAML implements yaml.Unmarshaler interface

type Dep

type Dep struct {
	Task string
	Vars *Vars
}

Dep is a task dependency

func (*Dep) UnmarshalYAML

func (d *Dep) UnmarshalYAML(unmarshal func(interface{}) error) error

UnmarshalYAML implements yaml.Unmarshaler interface

type IncludedTaskfile

type IncludedTaskfile struct {
	Taskfile       string
	Dir            string
	Optional       bool
	Internal       bool
	Aliases        []string
	AdvancedImport bool
	Vars           *Vars
	BaseDir        string // The directory from which the including taskfile was loaded; used to resolve relative paths
}

IncludedTaskfile represents information about included taskfiles

func (*IncludedTaskfile) DeepCopy

func (it *IncludedTaskfile) DeepCopy() *IncludedTaskfile

DeepCopy creates a new instance of IncludedTaskfile and copies data by value from the source struct.

func (*IncludedTaskfile) FullDirPath

func (it *IncludedTaskfile) FullDirPath() (string, error)

FullDirPath returns the fully qualified path to the included taskfile's working directory

func (*IncludedTaskfile) FullTaskfilePath

func (it *IncludedTaskfile) FullTaskfilePath() (string, error)

FullTaskfilePath returns the fully qualified path to the included taskfile

func (*IncludedTaskfile) UnmarshalYAML

func (it *IncludedTaskfile) UnmarshalYAML(unmarshal func(interface{}) error) error

UnmarshalYAML implements yaml.Unmarshaler interface

type IncludedTaskfiles

type IncludedTaskfiles struct {
	Keys    []string
	Mapping map[string]IncludedTaskfile
}

IncludedTaskfiles represents information about included tasksfiles

func (*IncludedTaskfiles) Len

func (tfs *IncludedTaskfiles) Len() int

Len returns the length of the map

func (*IncludedTaskfiles) Merge

func (tfs *IncludedTaskfiles) Merge(other *IncludedTaskfiles)

Merge merges the given IncludedTaskfiles into the caller one

func (*IncludedTaskfiles) Range

func (tfs *IncludedTaskfiles) Range(yield func(key string, includedTaskfile IncludedTaskfile) error) error

Range allows you to loop into the included taskfiles in its right order

func (*IncludedTaskfiles) Set

func (tfs *IncludedTaskfiles) Set(key string, includedTaskfile IncludedTaskfile)

Set sets a value to a given key

func (*IncludedTaskfiles) UnmarshalYAML

func (tfs *IncludedTaskfiles) UnmarshalYAML(node *yaml.Node) error

UnmarshalYAML implements the yaml.Unmarshaler interface.

type Output

type Output struct {
	// Name of the Output.
	Name string `yaml:"-"`
	// Group specific style
	Group OutputGroup
}

Output of the Task output

func (*Output) IsSet

func (s *Output) IsSet() bool

IsSet returns true if and only if a custom output style is set.

func (*Output) UnmarshalYAML

func (s *Output) UnmarshalYAML(unmarshal func(interface{}) error) error

UnmarshalYAML implements yaml.Unmarshaler It accepts a scalar node representing the Output.Name or a mapping node representing the OutputGroup.

type OutputGroup

type OutputGroup struct {
	Begin, End string
}

OutputGroup is the style options specific to the Group style.

func (*OutputGroup) IsSet

func (g *OutputGroup) IsSet() bool

IsSet returns true if and only if a custom output style is set.

type Precondition

type Precondition struct {
	Sh  string
	Msg string
}

Precondition represents a precondition necessary for a task to run

func (*Precondition) UnmarshalYAML

func (p *Precondition) UnmarshalYAML(unmarshal func(interface{}) error) error

UnmarshalYAML implements yaml.Unmarshaler interface.

type Task

type Task struct {
	Task                 string
	Cmds                 []*Cmd
	Deps                 []*Dep
	Label                string
	Desc                 string
	Summary              string
	Aliases              []string
	Sources              []string
	Generates            []string
	Status               []string
	Preconditions        []*Precondition
	Dir                  string
	Vars                 *Vars
	Env                  *Vars
	Silent               bool
	Interactive          bool
	Internal             bool
	Method               string
	Prefix               string
	IgnoreError          bool
	Run                  string
	IncludeVars          *Vars
	IncludedTaskfileVars *Vars
	IncludedTaskfile     *IncludedTaskfile
}

Task represents a task

func (*Task) DeepCopy

func (t *Task) DeepCopy() *Task

DeepCopy creates a new instance of Task and copies data by value from the source struct.

func (*Task) Name

func (t *Task) Name() string

func (*Task) UnmarshalYAML

func (t *Task) UnmarshalYAML(unmarshal func(interface{}) error) error

type Taskfile

type Taskfile struct {
	Version    string
	Expansions int
	Output     Output
	Method     string
	Includes   *IncludedTaskfiles
	Vars       *Vars
	Env        *Vars
	Tasks      Tasks
	Silent     bool
	Dotenv     []string
	Run        string
	Interval   string
}

Taskfile represents a Taskfile.yml

func (*Taskfile) ParsedVersion

func (tf *Taskfile) ParsedVersion() (float64, error)

ParsedVersion returns the version as a float64

func (*Taskfile) UnmarshalYAML

func (tf *Taskfile) UnmarshalYAML(unmarshal func(interface{}) error) error

UnmarshalYAML implements yaml.Unmarshaler interface

type Tasks

type Tasks map[string]*Task

Tasks represents a group of tasks

type Var

type Var struct {
	Static string
	Live   interface{}
	Sh     string
	Dir    string
}

Var represents either a static or dynamic variable.

func (*Var) UnmarshalYAML

func (v *Var) UnmarshalYAML(unmarshal func(interface{}) error) error

UnmarshalYAML implements yaml.Unmarshaler interface.

type Vars

type Vars struct {
	Keys    []string
	Mapping map[string]Var
}

Vars is a string[string] variables map.

func (*Vars) DeepCopy

func (vs *Vars) DeepCopy() *Vars

DeepCopy creates a new instance of Vars and copies data by value from the source struct.

func (*Vars) Len

func (vs *Vars) Len() int

Len returns the size of the map

func (*Vars) Merge

func (vs *Vars) Merge(other *Vars)

Merge merges the given Vars into the caller one

func (*Vars) Range

func (vs *Vars) Range(yield func(key string, value Var) error) error

Range allows you to loop into the vars in its right order

func (*Vars) Set

func (vs *Vars) Set(key string, value Var)

Set sets a value to a given key

func (*Vars) ToCacheMap

func (vs *Vars) ToCacheMap() (m map[string]interface{})

ToCacheMap converts Vars to a map containing only the static variables

func (*Vars) UnmarshalYAML

func (vs *Vars) UnmarshalYAML(node *yaml.Node) error

UnmarshalYAML implements the yaml.Unmarshaler interface.