Merge pull request #14 from mulesoft-labs/raml-1

Updated to RAML 1.0 AST

.gitignore

@@ -1,5 +1,7 @@
-node_modules
-bower_components
-coverage
+/node_modules/
+/bower_components/
+/coverage/
 .DS_Store
 npm-debug.log
+/typings/
+/dist/

.travis.yml

@@ -6,6 +6,6 @@ notifications:
     on_failure: change
 
 node_js:
-  - "0.12"
+  - "stable"
 
 after_script: "npm install coveralls@2 && cat ./coverage/lcov.info | coveralls"

README.md

@@ -5,7 +5,7 @@
 [![Build status][travis-image]][travis-url]
 [![Test coverage][coveralls-image]][coveralls-url]
 
-Generate files from a RAML document and Handlebars templates.
+> Generate files from a RAML document and templates.
 
 ## Installation
 
@@ -15,36 +15,28 @@ npm install raml-generator --save
 
 ## Usage
 
-The module accepts a map of Handlebars templates, partials and helpers, and exports a function that can be used to generate files from a RAML object and user data. For an example module, take a look at the [raml-javascript-generator](https://github.com/mulesoft-labs/raml-javascript-generator).
+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 an object specification. The returned object accepts two parameters, the RAML object and user package information.
+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': fs.readFileSync(__dirname + '/templates/index.js.hbs', 'utf8')
-  },
-  helpers: {
-    stringify: require('javascript-stringify')
+    'index.js': Handlebars.compile(fs.readFileSync(__dirname + '/templates/index.js.hbs', 'utf8'))
   }
 }) //=> [Function]
 ```
 
-### Handlebars
-
-Inside the Handlebars templates, the [RAML interface](https://github.com/mulesoft-labs/js-raml-object-interface) is exposed as Handlebars data.
-
-```hbs
-var baseUri = {{stringify baseUri}}
-```
-
-The user data is automatically provided as the Handlebars compile context.
-
 ### 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`.
@@ -59,6 +51,15 @@ 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

annotations.raml

@@ -0,0 +1,7 @@
+#%RAML 1.0 Library
+
+annotationTypes:
+  methodName:
+    type: string
+  displayName:
+    type: string

bin.d.ts

@@ -0,0 +1 @@
+export * from './dist/bin'

bin.js

@@ -0,0 +1 @@
+module.exports = require('./dist/bin')

custom_typings/raml-1-parser.d.ts

@@ -0,0 +1,8 @@
+import { Promise } from 'es6-promise'
+
+export interface Options {
+  rejectOnErrors?: boolean
+}
+
+export function loadApi (path: string, extensions?: string[], options?: Options): Promise<any>;
+export function loadApiSync (path: string, extensions?: string[], options?: Options): any;