ssube
/
salty-dog
1
0
Fork 0
Code

docs: add links to syntax and meta-rules

This commit is contained in:
ssube 2019-06-17 07:19:02 -05:00
parent 719954e2a8
commit e6c2da540e
1 changed files with 8 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/rules.md
View File

@ -2,6 +2,8 @@
Rules apply a schema fragment to a set of nodes selected from the original data.
This is a descriptive standard for rules. The enforced meta-rules for rules [are located here](../rules/salty-dog.yml).
- [Rules](#rules)
- [Metadata](#metadata)
- [Name](#name)
@ -37,14 +39,20 @@ A list of tags for the rule. Used for inclusion and exclusion.
JSON path used to select nodes from the data.
Uses [jsonpath-plus syntax](https://www.npmjs.com/package/jsonpath-plus#syntax-through-examples) in a string.
### Filter
Schema fragment used to filter selected nodes.
If a node matches the `select` path but does not match this schema, it will be skipped.
Uses [ajv syntax](https://ajv.js.org/keywords.html) in an object.
### Check
Schema fragment used to check selected nodes.
This is the real rule.
Uses [ajv syntax](https://ajv.js.org/keywords.html) in an object.