Documentation
¶
Index ¶
Constants ¶
const NamespaceSeparator = ":"
NamespaceSeparator contains the character that separates namespaces
Variables ¶
var ErrCantUnmarshalPrecondition = errors.New("task: Can't unmarshal precondition value")
ErrCantUnmarshalPrecondition is returned for invalid precond YAML.
var V3 = semver.MustParse("3")
Functions ¶
This section is empty.
Types ¶
type Call ¶
type Call struct {
Task string
Vars *Vars
Silent bool
Indirect bool // True if the task was called by another task
}
Call is the parameters to a task call
type Cmd ¶
type Cmd struct {
Cmd string
Task string
For *For
Silent bool
Set []string
Shopt []string
Vars *Vars
IgnoreError bool
Defer bool
Platforms []*Platform
}
Cmd is a task command
type ErrInvalidPlatform ¶
type ErrInvalidPlatform struct {
Platform string
}
func (*ErrInvalidPlatform) Error ¶
func (err *ErrInvalidPlatform) Error() string
type Include ¶
type Include struct {
Namespace string
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
}
Include represents information about included taskfiles
func (*Include) DeepCopy ¶
DeepCopy creates a new instance of IncludedTaskfile and copies data by value from the source struct.
func (*Include) FullDirPath ¶
FullDirPath returns the fully qualified path to the included taskfile's working directory
func (*Include) FullTaskfilePath ¶
FullTaskfilePath returns the fully qualified path to the included taskfile
type Includes ¶
type Includes struct {
omap.OrderedMap[string, Include]
}
Includes represents information about included tasksfiles
type Output ¶
type Output struct {
// Name of the Output.
Name string `yaml:"-"`
// Group specific style
Group OutputGroup
}
Output of the Task output
type OutputGroup ¶
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 ¶
Precondition represents a precondition necessary for a task to run
func (*Precondition) DeepCopy ¶
func (p *Precondition) DeepCopy() *Precondition
func (*Precondition) UnmarshalYAML ¶
func (p *Precondition) UnmarshalYAML(node *yaml.Node) error
UnmarshalYAML implements yaml.Unmarshaler interface.
type Requires ¶
type Requires struct {
Vars []string
}
Requires represents a set of required variables necessary for a task to run
type Task ¶
type Task struct {
Task string
Cmds []*Cmd
Deps []*Dep
Label string
Desc string
Prompt string
Summary string
Requires *Requires
Aliases []string
Sources []*Glob
Generates []*Glob
Status []string
Preconditions []*Precondition
Dir string
Set []string
Shopt []string
Vars *Vars
Env *Vars
Dotenv []string
Silent bool
Interactive bool
Internal bool
Method string
Prefix string
IgnoreError bool
Run string
IncludeVars *Vars
IncludedTaskfileVars *Vars
IncludedTaskfile *Include
Platforms []*Platform
Location *Location
Watch bool
}
Task represents a task
type Taskfile ¶
type Taskfile struct {
Location string
Version *semver.Version
Output Output
Method string
Includes *Includes
Set []string
Shopt []string
Vars *Vars
Env *Vars
Tasks Tasks
Silent bool
Dotenv []string
Run string
Interval time.Duration
}
Taskfile is the abstract syntax tree for a Taskfile
type Vars ¶
type Vars struct {
omap.OrderedMap[string, Var]
}
Vars is a string[string] variables map.
func (*Vars) DeepCopy ¶
DeepCopy creates a new instance of Vars and copies data by value from the source struct.
func (*Vars) ToCacheMap ¶
ToCacheMap converts Vars to a map containing only the static variables
Source Files