A Stoplight/Spectral linting ruleset for the JSON:API specification v1.0.
For ways to integrate this ruleset into your Spectral linting suite. See Sharing & Distributing Rulesets at https://meta.stoplight.io/
Rules and Rulesets are organized by section of the JSON:API specification:
- Primary Ruleset
./rules/jsonapi-ruleset.yaml
- Main Sections
./rules/jsonapi-{name-of-section}-ruleset.yaml
- Sub Sections
./rules/jsonapi-{name-of-section}.js
Each file extends rules/rulesets contained in its corresponding subsections.
In lieu of a formal style guide (I know... ironic 😁):
- Take care to maintain the existing coding style, including tests.
- Add tests for all new/edited rules including JSONPath testing.
- Verify all linting and tests PASS:
npm test