Schema#

https://doitoml.rtfd.io/en/latest/schema/_doitv0.schema.json#

doitoml configuration after full expansion

doitoml schema#

schema for doitoml configuration

type	object
properties
tokens	named command tokens
	command tokens
env	environment variables
	environment variables
paths	named paths
	path tokens
tasks	named tasks
	tasks
templates	extensible task generators
	type	object
additionalProperties	False

array-of-strings#

type	array
items	type	string

array-of-paths#

type	array
items	type	string
items	minLength	1

tasks#

doit tasks

type	object
additionalProperties	Task

Task#

a doit task

type	object
properties
actions	actions to perform as strings, lists of tokens, or custom objects
	actions
calc_dep	array-of-paths
doc	type	string
file_dep	array-of-paths
meta	Metadata
name	type	string
targets	array-of-paths
title	type	string
uptodate	uptodates
verbosity	verbosity
watch	array-of-paths

Metadata#

type	object
properties
doitoml	doitoml Metadata

doitoml Metadata#

type	object
properties
cwd	type	string
env	environment variables
skip	oneOf	type	string
		type	number
		type	null
		type	object
source	type	string
log	doitoml-log
additionalProperties	False

doitoml-log#

type	array
items	oneOf	type	string
		type	null

actions#

type	array
items	action

action#

oneOf	shell action
	token action
	actor action

uptodates#

type	array
items	uptodate

uptodate#

oneOf	type	boolean
	type	string
	type	object
	type	null

token action#

type	array
items	type	string

shell action#

type

string

actor action#

a custom action

type	object
anyOf	an uncharacterized custom action provided by an entry_point
	type	object

command tokens#

command tokens which may be expanded as paths

type	object
additionalProperties	array-of-strings

environment variables#

environment variables shared among all tasks

type	object
additionalProperties	type	string

path tokens#

paths to expand and normalize, relative to the current working directory

type	object
additionalProperties	array-of-paths

verbosity#

level of console output to show. 0 shows no output, 1 shows error output, 2 shows all output

type	number
enum	0, 1, 2