Package Exports

@stoplight/spectral

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@stoplight/spectral) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

spectral

Warning This is still a prototype and not ready for general use.

This is an enhanced version of the speccy project. Differences between this project and speccy include:

Lint rules can be applied to any JSON object, not just OAS3 specifications.
All dependencies on the oas-kit repository have been removed, since rules are no longer OAS-specific.
The rule structure has been modified slightly to use JSONPath path parameters instead of the object parameters (which were OAS-specific).
Rules are more clearly defined (thanks to TypeScript typings) and now require specifying a type parameter.
Some rule types have been enhanced to be a little more flexible. An example of this includes the ability to specify the object to be linted in the path parameter itself, instead of relying on rule-specific options to be applied.
Ported to TypeScript.

Things that speccy has, but spectral does not (though they would be easy to add):

A 'server' and CLI mode
The ability to add rules from file
The ability for rule files to specify a dependency on other rule files

Usage

import { Spectral } from '@stoplight/spectral';
import { defaultRuleset } from '@stoplight/spectral/rulesets';

// an OASv2 specification
var myOAS = {
  [...]
  responses: {
    '401asdf': {
      description: '',
      schema: {
        $ref: '#/definitions/error-response',
      },
    },
  },
  [...]
};

// create a new instance of spectral with all of the baked in rulesets
const spectral = new Spectral({ rulesets: [defaultRuleset()] });

// run!
console.log(spectral.run({ spec: 'oas2', target: myOAS }));

//  [ {
//   path: '$.responses',
//   rule:
//     { type: 'pattern',
//       name: 'all-responses-must-be-numeric',
//       path: '$..responses',
//       enabled: true,
//       description: 'reference components should all match regex ^[0-9]+',
//       pattern: { property: '*', value: '^[0-9]+$' } },
//     error:
//       Error {
//         operator: 'to be',
//         expected: true,
//         message: 'reference components should all match regex ^[0-9]+',
//         showDiff: true,
//         actual: false,
//         stackStartFunction: [Function: assert],
//         negate: false,
//         assertion:
//         Assertion {
//           obj: false,
//           anyOne: false,
//           negate: false,
//           params: [Object],
//           onlyThis: undefined,
//           light: false } } } ]

Helpful Links

JSONPath Tester