Skip to main content

Module settings

Module settings 

Source
Expand description

speccoder.toml as settings: a catalogue of every key — its type, default and meaning — the values a project sets, and edits that keep the file’s comments and are checked by every parser before they are written. speccoder reads committed configuration only, so a change is offered as a commit of exactly this file.

Structs§

Key
One key of the catalogue.
Section
One section of the catalogue.

Enums§

Kind
What a key holds.

Constants§

CATALOGUE
Every key of speccoder.toml, in the reference’s order. A test holds it to the parsers and to the configuration reference.
PREFIX_KEYS
The keys only a coverage preview’s confirmation writes.

Functions§

apply
speccoder config set|unset, and the page’s save: applies changes to the file, all or nothing. A prefix key is refused: it is saved only as the confirmation of its coverage preview (WidenPolicy); removing an entry (unset) narrows and is allowed.
commit
speccoder config commit: commits exactly speccoder.toml, nothing else staged, once every parser accepts it.
edit
The new text with changes applied, or why not.
read
The configuration as settings: every key, set or default.
show
speccoder config: the settings.
validate
Whether every parser accepts text — the same ones every command uses.
value_of
A value for key from the words of config set KEY WORDS…: JSON when it parses as the key’s kind, else words read by the kind (cargo fmt for an argv, 40 for a number, on/off for a switch).