chrinor2002/raml2obj

RAML to object.

RAML to object

A thin wrapper around raml-js-parser-2, adding extra properties to the resulting object for use in raml2html and raml2md.

Versions 4.0.0 and up only support RAML 1.x files. If you still have RAML 0.8 source files, please stick with raml2obj 3.

Install

npm i raml2obj --save

Usage

var raml2obj = require('raml2obj');

// source can either be a filename, url, or parsed RAML object.
// Returns a promise.
raml2obj.parse(source).then(function(ramlObj) {
  // Do something with the resulting ramlObj :)
});

Contribute

raml2obj is an open source project and your contribution is very much appreciated.

1. Check for open issues or open a fresh issue to start a discussion around a feature idea or a bug.
2. Fork the repository on Github and make your changes on the develop branch (or branch off of it). Run npm run lint before committing to check for common problems and auto format all code.
3. Add unit tests, run them with npm run test
4. Send a pull request (with the develop branch as the target).

A big thank you goes out to everyone who helped with the project, the contributors and everyone who took the time to report issues and give feedback.

License

raml2obj is available under the MIT license. See the LICENSE file for more info.