Skip to content

A Stoplight/Spectral linting ruleset for the JSON:API specification.

License

Notifications You must be signed in to change notification settings

jmlue42/spectral-jsonapi-ruleset

This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Folders and files

NameName
Last commit message
Last commit date
Oct 18, 2023
Oct 11, 2022
Dec 7, 2023
Dec 12, 2023
Dec 12, 2023
Oct 11, 2022
Dec 7, 2023
Oct 23, 2020
Oct 19, 2020
Oct 11, 2022
Dec 7, 2023
Dec 7, 2023

Repository files navigation

spectral-jsonapi-ruleset

Node.js CI CodeQL

A Stoplight/Spectral linting ruleset for the JSON:API specification v1.0.

Installation

For ways to integrate this ruleset into your Spectral linting suite. See Sharing & Distributing Rulesets at https://meta.stoplight.io/

Organization

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.

Contributing

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

License

MIT License

Releases

No releases published

Packages

No packages published

Languages