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
Bot releases are visible (Hide)
Published by stoplight-bot over 5 years ago
Published by stoplight-bot over 5 years ago
2.0.0 (2019-03-28)
Features
- Added a CLI for linting without needing to play with JavaScript (#105)
- Use json-ref-parser by default to provide dereferenced object, (#99)
- Add file paths and line numbers to results, used for CLI output (#106 & #117)
- Show YAML parsing errors as results (#118)
BREAKING CHANGES
- The
spectral.run()method is now async, so add theawaitkeyword before it - The
spectral.run()method now returns an array of results, instead of an object containing an array - Removed
schema-items-is-objectrule (#100) (2e5902f)
Before
const resolved = someCustomResolver(specification);
const results = spectral.run(specification, { resolvedTarget: resolved });
console.log(results.results) // [ { ... } ]
After
const results = await spectral.run(specification);
console.log(results) // [ { ... } ]
This is a big simplification to the API, as it will resolve things for you (internal $ref only, so any $ref which is pointing to a location within the same file).
The ability to pass in other resolvers to support external references or other resolving strategies will come in future versions.
Published by stoplight-bot over 5 years ago
