node-raml-validate icon indicating copy to clipboard operation
node-raml-validate copied to clipboard

RAML 0.8 automated validation

Open alvassin opened this issue 9 years ago • 1 comments

I want to perform automated validation of following things on git pre-commit hook:

  • RAML 0.8 syntax
  • json-schemas (with $refs)
  • examples (from my experience 99% of mistakes or typos are here, must have)

As i see, this module is not intended to perform this (i even can't see raml-js-parser in dependencies and i can't get how to perform deep validation without it). Perhaps you can advice a best way to implement such validation?

In fact, raml-js-parser itself is able to parse RAML 0.8 and dereference all schemas using key dereferenceSchemas=true. So, perhaps it would be enough to see if RAML file with dereferenced is just being parsed successfully.

Also, there is module tv4 that can validate json against given json-schema. They can be used together to perform automated tests. What do you think?

P.S. I've created in a separate thread, because this issue is about version 1.0.

alvassin avatar May 01 '16 10:05 alvassin

Hi @alvassin, this module actually has a far-reaching name for what it does ;), it simply validates named-parameters (like headers, URI params, etc)

It is used from other modules, like https://github.com/mulesoft/osprey , to support full API support, validations, etc. You are right that it does not take an actual RAML file, it takes its parsed output, and a

The right move for this project would be to be renamed, but too many things would break.

I would not be opposed of adding example validations to the RAML parser (I think it is the only missing item from your wish-list)

dmartinezg avatar May 02 '16 12:05 dmartinezg