john-slop/examples/config/README.md

36 lines
1.2 KiB
Markdown

# Commented configuration examples
Copy [`config.toml`](config.toml) to the platform path printed by
`john-slop config paths` for user-wide policy. Copy [`editorial.toml`](editorial.toml)
beside it and select it with `--config-name editorial` for a named overlay.
Both are deliberately partial. Embedded defaults remain active for fields and
stable IDs they do not mention. Inspect the exact merged result before enforcing
it:
```sh
john-slop config show --config-name editorial
```
Project-local policy can use either file with `--config path/to/file.toml`.
The CLI can also create the embedded commented base in the current directory:
```sh
john-slop config init
```
It preserves an existing `config.toml` unless `--force` is explicit.
[`diagnostics.toml`](diagnostics.toml) is a complete runtime rule definition.
Place it at the `user_diagnostics` path reported by `john-slop config paths` for
automatic loading, or keep it with a project and select it explicitly:
```sh
john-slop --diagnostics examples/config/diagnostics.toml article.md
john-slop-lsp --diagnostics examples/config/diagnostics.toml
```
Generate the commented starter with `john-slop config init-diagnostics`. The
starter rule is disabled until its phrase and metadata are intentionally
customized.