grunt-js-api-generator

Generate api module from config file.

Getting Started

This plugin requires Grunt >=0.4.0

If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

npm install grunt-js-api-generator --save

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

grunt.loadNpmTasks('grunt-js-api-generator');

The "js-api-generator" task

Overview

In your project's Gruntfile, add a section named js-api-generator to the data object passed into grunt.initConfig().

grunt.initConfig({
  js-api-generator: {
    your_target: {
        // options
    },
  },
})

Options

All options in "js-api-generator" module are supported. You may read this page for more detail.

Example

grunt.initConfig({
  js-api-generator: {
    test: {
        target: 'test/api.yml',
        utlify: true
    }
  },
})

Demo

grunt test

History

Update with js-api-generator