Skip to main content

Module tasks

Module tasks 

Source
Expand description

Task blocks in kizz.md files.

A task is a fenced code block, with a backtick or tilde fence, whose info string is starlark followed by targets, task options, or both. After starlark, a word with = is a task option and every other word is a target. The options are name=<name>, which names the task with the characters of a target name, uniquely within its kizz.md, and cache=never, which makes every command of the task run as if it were marked always. The nearest heading above the block is the task’s heading. A starlark block nested in another fenced block is that block’s content, not a task, and a starlark block with neither targets nor a name is not a task either, but gets a warning; its options are still checked.

Structs§

ParsedFile
What parsing one kizz.md found.
Task
A task: one starlark block with targets, a name, or both, in a kizz.md.
TaskOptions
The options of a task block: the words of its info string that hold =.

Enums§

OptionProblem
What is wrong with one task option, a configuration error.

Constants§

TASK_LANGUAGE
The first word of the info string of every task block.
TASK_NAME_RULE
The rule every task name follows, as error messages state it.
TASK_OPTION_KEYS
The keys of the task options, in the order output shows them.

Functions§

parse_tasks
Parse the task blocks of one kizz.md.