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§
- Parsed
File - What parsing one
kizz.mdfound. - Task
- A task: one
starlarkblock with targets, a name, or both, in akizz.md. - Task
Options - The options of a task block: the words of its info string that hold
=.
Enums§
- Option
Problem - 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.