grunt-apigen v0.1.3

grunt-apigen

Grunt task for generating Apigen documentation.

This is my very first Grunt plugin, so proceed with caution. For more info about Apigen documentation library, check their website and GitHub repository:

• http://www.apigen.org/
• https://github.com/apigen/

For now, it supports only the most basic options - source of scripts and destination of documentation. More options on the way - hopefully soon.

Prerequisities

First, install Apigen. Check Apigen website for recommended ways how to do so.

Personally, I've installed Apigen by Composer globally.

$ composer global require apigen/apigen
$ composer update

You also need to add path to your global Composer packages to your $PATH variable.

PATH=~/.composer/vendor/bin:$PATH

You can check if Apigen is working for you regardless of your setup by:

$ apigen --version

Getting started (Grunt)

This plugin requires Grunt ~0.4.5

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-apigen --save-dev

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

grunt.loadNpmTasks('grunt-apigen');

Options

For now, plugin supports only 2 options to mimic basic Apigen command:

apigen generate --source src --destination api

options.apigenPath

Type: String Default value: vendor/bin/

Location of apigen script

options.source

Type: String Default value: ./

Files to be documented. Current directory by default. Works recursively.

options.destination

Type: String Default value: ./apigen-docs

Destination of Apigen output.

Release History

0.1.0

• Initial release.

0.1.2

• Added an actual readme.
• Fixed bug with adding to command (instead of overwriting it).
• Deleted test directory.

0.1.3

• Added apigenPath option
• Fixed npm install mistake in README
• Fixed Github path in package.json

ToDo list

• Fix console output to support Apigen's fancy progress bar.
• Support all Apigen's options.
• Do unit tests!