Andreas/markdownlint
1
0
Fork 0
mirror of https://github.com/DavidAnson/markdownlint.git synced 2025-12-16 14:00:13 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Add instructions for "Validating Configuration" to explain how to use the JSON Schema with configuration objects/files.

Browse source
This commit is contained in:
David Anson 2023-11-26 20:10:31 -08:00
parent 7df23eed2c
commit 9270513f14
3 changed files with 32 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

28
schema/ValidatingConfiguration.md Normal file
View file

@ -0,0 +1,28 @@
# Validating Configuration
A [JSON Schema][json-schema] is provided to enable validating configuration
objects: [`markdownlint-config-schema.json`][markdownlint-config-schema]
Some editors automatically use a JSON Schema with files that reference it. For
example, a `.markdownlint.json` file with:
```json
"$schema": "https://raw.githubusercontent.com/DavidAnson/markdownlint/main/schema/markdownlint-config-schema.json"
```
A JSON Schema validator can be used to check configuration files like so:
```bash
npx ajv-cli validate -s ./markdownlint/schema/markdownlint-config-schema.json -d "**/.markdownlint.{json,yaml}" --strict=false
```
By default, any rule name is valid in order to allow for custom rules. To ensure
that only built-in rules are used, change the value of `#/additionalProperties`
(at the bottom of the schema file) to `false` before validating:
```json
"additionalProperties": false
```
[json-schema]: https://json-schema.org
[markdownlint-config-schema]: markdownlint-config-schema.json