Giter Club home page Giter Club logo

spectral-jsonapi-ruleset's Introduction

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

spectral-jsonapi-ruleset's People

Contributors

marquje avatar dependabot[bot] avatar ezenity avatar jmlue42 avatar ali-fazal avatar poddaan avatar alphabetadelta avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.