models

Documentation

Index

• type DepsBehaviour
  • func ParseDepsBehaviour(s string) (DepsBehaviour, bool)
  • func (b DepsBehaviour) String() string
• type RequiredBehaviour
  • func ParseRequiredBehaviour(s string) (RequiredBehaviour, bool)
  • func (b RequiredBehaviour) String() string
• type Task
  • func (t Task) Display(w io.Writer)
• type Tasks
  • func (ts Tasks) Get(tsname string) (task Task, ok bool)

Types

type DepsBehaviour

type DepsBehaviour int

DepsBehaviour represents how a tasks dependencies are run. The default is DependencyBehaviourSync

const (
	// DependencyBehaviourSync should be used if the dependencies are to be run synchronously.
	DependencyBehaviourSync DepsBehaviour = iota
	// DependencyBehaviourAsync should be used if the dependencies are to be run asynchronously.
	DependencyBehaviourAsync
)

func ParseDepsBehaviour

func ParseDepsBehaviour(s string) (DepsBehaviour, bool)

func (DepsBehaviour) String

func (b DepsBehaviour) String() string

type RequiredBehaviour

type RequiredBehaviour int

RequiredBehaviour represents a tasks behaviour when required by another task. The default is RequiredBehaviourAlways

const (
	// RequiredBehaviourAlways should be used if the task is to be run every time it is required.
	RequiredBehaviourAlways RequiredBehaviour = iota
	// RequiredBehaviourOnce should be used if a task should be run once, even if required multiple times.
	RequiredBehaviourOnce
)

func ParseRequiredBehaviour

func ParseRequiredBehaviour(s string) (RequiredBehaviour, bool)

func (RequiredBehaviour) String

func (b RequiredBehaviour) String() string

type Task

type Task struct {
	Name              string
	Description       []string
	Script            string
	Dir               string
	Env               []string
	DependsOn         []string
	Inputs            []string
	ParsingError      string
	RequiredBehaviour RequiredBehaviour
	DepsBehaviour     DepsBehaviour
	Interactive       bool
}

Task represents a parsed Task.

func (Task) Display

func (t Task) Display(w io.Writer)

Display writes a Task as Markdown.

type Tasks

type Tasks []Task

Tasks is an alias type for []Task

func (Tasks) Get

func (ts Tasks) Get(tsname string) (task Task, ok bool)

Get returns a task by name, case insensitively.