Skip to main content

Module user_config

Module user_config 

Source
Expand description

The person’s own settings, ~/.config/speccoder/config.toml: how speccoder gets their attention. Never read from the committed speccoder.toml, which is the project’s policy.

Structs§

Notify
[ui.notify].
Settings
The person’s settings.
Ui
How output looks ([ui]): values as written, checked here; unset is None (the renderer’s default).

Enums§

Method
How attention is asked for.
Signal
What may ask for attention.

Constants§

PROJECT_ONLY
Keys that are the project’s policy, never the person’s: a value in the user config is refused with a warning naming it (until settings learn which keys a person may tighten).

Functions§

load
The settings and a warning per value that was not understood (the default is used for it). A missing file is all defaults.
parse
load from text, naming file in warnings.
parse_ui
[ui]’s look keys from text ([ui.notify] is parse’s).
path
The settings file: $XDG_CONFIG_HOME/speccoder/config.toml when set, else $HOME/.config/speccoder/config.toml.
project_only
One warning per PROJECT_ONLY key text sets.