Go API Documentation

github.com/go-task/task/v3/taskrc

No package summary is available.

Package

Files: 2. Third party imports: 1. Imports from organisation: 0. Tests: 0. Benchmarks: 0.

Vars

Types

Node

This type doesn't have documentation.

Field name Field type Comment
entrypoint

string

No comment on field.
dir

string

No comment on field.

DebugFunc, ReaderOption, Reader

This type doesn't have documentation.

Field name Field type Comment
type

func(string)

No comment on field.
type

any

No comment on field.
debugFunc

DebugFunc

No comment on field.

debugFuncOption

This type doesn't have documentation.

Field name Field type Comment
debugFunc

DebugFunc

No comment on field.

Functions

func NewNode

Uses: fsext.DefaultDir, fsext.Search.

func NewReader

NewReader constructs a new Taskfile [Reader] using the given Node and options.

func WithDebugFunc

WithDebugFunc sets the debug function to be used by the [Reader]. If set, this function will be called with debug messages. This can be useful if the caller wants to log debug messages from the [Reader]. By default, no debug function is set and the logs are not written.

func (*Reader) Options

Options loops through the given [ReaderOption] functions and applies them to the [Reader].

func (*Reader) Read

Read will read the Task config defined by the [Reader]'s [Node].

Uses: ast.TaskRC, os.ErrInvalid, os.ReadFile.

func (*debugFuncOption) ApplyToReader