spectral

A flexible JSON/YAML linter for creating automated style guides, with baked in support for OpenAPI v3.1, v3.0, and v2.0 as well as AsyncAPI v2.x.

APACHE-2.0 License

Downloads
22.3M
Stars
2.3K
Committers
92

Bot releases are hidden (Show)

spectral -

Published by P0lip about 3 years ago

Fixed

  • Dependencies upgrade for audit fixes
spectral - v1.0.1

Published by marbemac almost 6 years ago

1.0.1 (2018-12-21)

Bug Fixes

  • severity: default severity should be warning (#74) (11fa690)
spectral - v1.0.0

Published by marbemac almost 6 years ago

1.0.0 (2018-12-11)

Bug Fixes

  • allowing passing in ruleStore to run instead of using this._ (fb72fc4)
  • prevent ruleset to be mutated (a793b6c)
  • remove format form getRule rule name (2dec3bb)
  • dep: bump lodash (201405c)
  • imports: fix imports (ea1d029)
  • security: add back oasOpSecurityDefined (d93ef40)
  • severity pass through (eb0699c)
  • typo in api-host rule description (51595ca)
  • use extact equality instead of index of (16e5992)

chore

Features

  • add 'when' statement support (0618337)
  • add an option to set rules that allow complete reset (35bbf42)
  • allow multiple rules with identical names (2b13d49)
  • change 'run' function signature and simplify (21b4a70)
  • enrich IRuleResult with extra props (212cdaa)
  • make given not required (78aad4f)
  • remove the idea of pipes, matches on rule format hould be exact (7ba143e)
  • support list of then objects for single rule (ba8a683)

BREAKING CHANGES

  • published build will no longer be nested in dist, which means old deep imports e.g. @stoplight/spectral/dist/rulesets should now be @stoplight/spectral/rulesets.
  • use our standard build process, file conventions, and commit conventions
  • relaxes some of the deps
  • rule's name changed.
    Was: a simple {name}
    Is: "{format}-{name}"
Package Rankings
Top 1.02% on Npmjs.org
Top 24.92% on Repo1.maven.org
Top 8.17% on Proxy.golang.org
Top 36.01% on Pypi.org
Badges
Extracted from project README
Demo of Spectral linting an OpenAPI document from the CLI CircleCI npm Downloads Stoplight Forest
Related Projects