Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mulesoft-labs/raml-generator
Generate files from a RAML document and Handlebars templates
https://github.com/mulesoft-labs/raml-generator
raml raml-generator raml-tooling raml-utilities
Last synced: about 1 month ago
JSON representation
Generate files from a RAML document and Handlebars templates
- Host: GitHub
- URL: https://github.com/mulesoft-labs/raml-generator
- Owner: mulesoft-labs
- License: other
- Archived: true
- Created: 2015-03-10T09:02:14.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2023-06-20T22:20:28.000Z (over 1 year ago)
- Last Synced: 2024-08-06T09:01:13.858Z (about 2 months ago)
- Topics: raml, raml-generator, raml-tooling, raml-utilities
- Language: RAML
- Size: 48.8 KB
- Stars: 31
- Watchers: 388
- Forks: 11
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# RAML Generator
[](https://greenkeeper.io/)
[![NPM version][npm-image]][npm-url]
[![NPM downloads][downloads-image]][downloads-url]
[![Build status][travis-image]][travis-url]
[![Test coverage][coveralls-image]][coveralls-url]
> Generate files from a RAML document and templates.
## Installation
```
npm install raml-generator --save
```
## Usage
The module accepts a map of functions (usually compiled templates, such as Handlebars), and returns a function that will generate files given an instance of the RAML 1 parser JSON.
For an example module, take a look at the [raml-javascript-generator](https://github.com/mulesoft-labs/raml-javascript-generator).
Why use this? It's just a simple, high level API for creating generators with a standard API.
### JavaScript Usage
Create the generator function from config. The returned object accepts two arguments, the RAML object and user config.
```js
var fs = require('fs')
var Handlebars = require('handlebars')
var generator = require('raml-generator')
module.exports = generator({
templates: {
'index.js': Handlebars.compile(fs.readFileSync(__dirname + '/templates/index.js.hbs', 'utf8'))
}
}) //=> [Function]
```
### Bin Script
A `bin` script is provided for you to use with your custom generator. Just require `raml-generator/bin` and pass in the generator function (from above), package information (`package.json`) and `process.argv`.
```js
#!/usr/bin/env node
var bin = require('raml-generator/bin')
var generator = /* The generator function */
bin(generator, require('./package.json'), process.argv)
```
Generated CLI:
```sh
generator --out [directory]
--data, -d Path to JSON configuration file
--include, -i Include additional RAML files (E.g. extensions)
```
## License
Apache License 2.0
[npm-image]: https://img.shields.io/npm/v/raml-generator.svg?style=flat
[npm-url]: https://npmjs.org/package/raml-generator
[downloads-image]: https://img.shields.io/npm/dm/raml-generator.svg?style=flat
[downloads-url]: https://npmjs.org/package/raml-generator
[travis-image]: https://img.shields.io/travis/mulesoft-labs/raml-generator.svg?style=flat
[travis-url]: https://travis-ci.org/mulesoft-labs/raml-generator
[coveralls-image]: https://img.shields.io/coveralls/mulesoft-labs/raml-generator.svg?style=flat
[coveralls-url]: https://coveralls.io/r/mulesoft-labs/raml-generator?branch=master