Documentation
¶
Index ¶
- Variables
- func Dotenv(c compiler.Compiler, tf *taskfile.Taskfile, dir string) (*taskfile.Vars, error)
- func Exists(path string) (string, error)
- func ExistsWalk(path string) (string, error)
- func Taskfile(node Node, insecure bool, download bool, offline bool, timeout time.Duration, ...) (*taskfile.Taskfile, error)
- func Taskvars(dir string) (*taskfile.Vars, error)
- type BaseNode
- type Cache
- type FileNode
- type HTTPNode
- type Node
- type NodeOption
Constants ¶
This section is empty.
Variables ¶
var ( // ErrIncludedTaskfilesCantHaveDotenvs is returned when a included Taskfile contains dotenvs ErrIncludedTaskfilesCantHaveDotenvs = errors.New("task: Included Taskfiles can't have dotenv declarations. Please, move the dotenv declaration to the main Taskfile") )
Functions ¶
func Exists ¶
Exists will check if a file at the given path Exists. If it does, it will return the path to it. If it does not, it will search the search for any files at the given path with any of the default Taskfile files names. If any of these match a file, the first matching path will be returned. If no files are found, an error will be returned.
func ExistsWalk ¶
ExistsWalk will check if a file at the given path exists by calling the exists function. If a file is not found, it will walk up the directory tree calling the exists function until it finds a file or reaches the root directory. On supported operating systems, it will also check if the user ID of the directory changes and abort if it does.
func Taskfile ¶
func Taskfile( node Node, insecure bool, download bool, offline bool, timeout time.Duration, tempDir string, l *logger.Logger, ) (*taskfile.Taskfile, error)
Taskfile reads a Taskfile for a given directory Uses current dir when dir is left empty. Uses Taskfile.yml or Taskfile.yaml when entrypoint is left empty
Types ¶
type BaseNode ¶
type BaseNode struct {
// contains filtered or unexported fields
}
BaseNode is a generic node that implements the Parent() and Optional() methods of the NodeReader interface. It does not implement the Read() method and it designed to be embedded in other node types so that this boilerplate code does not need to be repeated.
func NewBaseNode ¶
func NewBaseNode(opts ...NodeOption) *BaseNode
type FileNode ¶
A FileNode is a node that reads a taskfile from the local filesystem.
func NewFileNode ¶
func NewFileNode(uri string, opts ...NodeOption) (*FileNode, error)
type HTTPNode ¶
An HTTPNode is a node that reads a Taskfile from a remote location via HTTP.
func NewHTTPNode ¶
func NewHTTPNode(uri string, insecure bool, opts ...NodeOption) (*HTTPNode, error)
type Node ¶
type NodeOption ¶
type NodeOption func(*BaseNode)
func WithOptional ¶
func WithOptional(optional bool) NodeOption
func WithParent ¶
func WithParent(parent Node) NodeOption
Source Files