idk-plans

Configuration

module

● 100% (3/3)

Reads idk-plans.config.json and fills in defaults. It also holds the JSON schema that editors use to check the file.

The configuration names the trees, the files to scan, and how loud each check is. A project without a configuration file gets one tree, system, and the default rules.

How it works

src/config.js reads the file, if there is one. resolveConfig fills in defaults and stops with an error when a value is not valid. For example, exactly one tree must be primary.

schema/config.schema.json describes the same fields for editors. Put "$schema": "./node_modules/@method-run/idk-plans/schema/config.schema.json" in the file to get completion and warnings.

Section 9 of the Specification lists every field.

Tasks

  • Default to one primary tree
  • Let each rule be error, warn, info, or off
  • Add proseWrap

Linked from