okforest/settings-keys

warningOKForest conventions

.okforest/settings.yaml uses only the settings OKForest knows; others, such as a misspelled key, are ignored.

Why

OKForest ignores settings it doesn’t know, so a misspelled one is lost without a word. This warning catches it, and suggests the setting you probably meant. The settings are name, description, and ignore (Settings).

Example

This file breaks the rule:

.okforest/settings.yaml

nmae: Acme knowledge

okforest validate reports:

.okforest/settings.yaml
  1:1  warning  Unknown setting `nmae`: did you mean `name`? Unknown settings are ignored.  okforest/settings-keys

Fixed:

.okforest/settings.yaml

name: Acme knowledge