Logs task routes before execution and/or upon success.
Task
Catches errors in a task
, preventing it
from stopping execution of other tasks
when run in series or parallel.
When a task
raises an exception,
it will log the error message with
a given options.level
, and optionally
run an alternate
task.
Task
Clears stdout when a TTY
Task
Takes a task nested record tasks
and runs a number
of them in series as selected by the inclusion or exclusion options.
Task
Uses a context's stdio to prompt for confirmation. Executes a task in response to user confirmation or rejection.
Task
Modifies a task's context with a given context
.
Takes a context
as a first argument, which
can be a partial Context
object, or
a callback receiving a Context
and
returning a partial Context
object.
Task
Copies files or directories from paths
to destination
.
Treats destination
as a folder unless options.single
is true
.
Task
Reads files as specified in paths
, calling the cb
callback with a Buffer for each file read.
The callback's responses will be written into the
original file path.
If the callback returns an object, it will be
stringified as JSON.
Task
Spawns a process. When no file is passed, it will execute node.
Task
Fetch a tasks file that's expected to have
a Task.Record
as a default export.
Returns true
when a context's environment
variables indicate it's running in a CI.
A promise returning function that will
resolve with true
if context.cancellation
has finalized, and false
otherwise.
Returns true
when a context is that
of an interactive environment.
Ensures that there's a TTY stdin and stdout,
it's a non-dumb terminal, and not running in a CI.
Lifts all tasks on a tasks
record to a package.json file,
which is expected to be available at the context's working directory.
The tasks
argument can be a record itself, a string
with the path of the tasks record, or empty to fetch
it at the default path.
Task
Prints all available tasks in a tasks
record
on a context's stdout.
Task
Creates a directory.
Task
Moves files or directories from paths
to destination
.
Treats destination
as a folder unless options.single
is true
.
Task
Returns a Task
that will run in parallel
a set of given tasks.
Suppresses the context's stdin.
For tasks passed as arguments, the route
will be left unmodified, while task
lists and records will inherit their
index or key name for their route.
Task
Writes a message or other data into a context's stdout.
Task
Shows a spinner upon task initialization,
and a success message on successful finalization.
Will suppress the context's stdio.
Non-interactive environments will fallback to announce
.
Logging levels equal or above debug will fallback to
logging the start and successful finalization of a task,
while maintaining the context's stdout and stderr.
Task
Uses a context's stdio to prompt for a user response.
The response will be prepended to the context arg array
for task
, when valid.
Task
Maps all tasks in a Task.Record
.
Removes files or directories as specified in paths
.
Task
Uses a context's stdio to prompt for input.
Executes a task in response to user selection.
Takes in a record of tasks
.
Task
Returns a Task
that will run in series
a set of given tasks.
For tasks passed as arguments, the route
will be left unmodified, while task
lists and records will inherit their
index or key name for their route.
Task
Waits for a given number of milliseconds.
Task
Styles a string
Watches paths
for changes and runs a given
task
for every change event.
Task
Writes a file with a content
at path
.
When content
is an object, it will be
stringified as JSON.
Task
Generated using TypeDoc
A task, that being a
Context
receiving function, optionally async.