Update documentation to reflect latest recommendations
Closed this issue · 3 comments
Hello, first of all thanks for open sourcing this project!
As I was searching through some older issues I came across this recommendation:
Our recommendation moving forward is to use Spectral's Node API and import our ruleset as a dependency to get consistent behavior with the CLI tool. That's what the CLI tool is doing behind the scenes.
To be honest this is the first time I have heard about Spectral and therefore it was not immediately clear to me how to hook this API validation ruleset up with the Spectral NPM package. I was wondering if you could provide a simple update to the current README to reflect your latest recommendation.
Many thanks :)
Hello @dustinmoris - I'm glad the project looks beneficial to you!
That's a good suggestion. We'll look at adding that in the docs. In the meantime, we do have a quick guide in our README for the ruleset package itself. The way to hook it up is to install our ruleset (which is a standalone package), install Spectral separately, and write a Node program to utilize them together as in the linked example.
🎉 This issue has been resolved in version 1.19.0 🎉
The release is available on npm package (@latest dist-tag)
Your semantic-release bot 📦🚀
🎉 This issue has been resolved in version 1.20.0 🎉
The release is available on npm package (@latest dist-tag)
Your semantic-release bot 📦🚀