generator-mozu-actions

Kibo API Extension generator

Maintainer: James Zetlen

A Kibo API Extension generator for Yeoman that provides boilerplate and structure for writing Kibo Api Extension Functions against the family of Kibo API Extensions. It provides documented function stubs, a build process using Grunt and Browserify, remote sync with the Developer Center, and unit tests using Mocha plus the Kibo Action Simulator.

Usage

First, install Yeoman's command line tool if you haven't already!

npm install yo  -g

Yeoman looks for globally installed NPM packages that identify themselves as Yeoman generators. So install the generator globally. Also, install the grunt-cli command line Grunt package, because you'll need it.

npm install -g generator-mozu-actions grunt-cli

Make a new directory and cd into it:

mkdir example && cd example

Run the Yeoman generator!

yo mozu-actions

Options

• --skip-install

  Skips the automatic execution of npm install after scaffolding has finished.

• --skip-prompts

  Often you may find yourself rerunning the generator in the same directory. Your answers to prompts are saved; if you want to quickly re-run the generator without prompts, use this option. Will not work if you've never run the generator in this directory before.

• --quick

  Equivalent to --skip-install --skip-prompts.

• --internal

  Allows integration with non-production Mozu environments. The prompts will include an extra question about which environment to sync with.

Creating Additional Actions

The generator uses a Yeoman sub-generator to create the action implementation scaffolds and unit test scaffolds. You can call this sub-generator directly, after creating your project, to add more scaffolding for additional actions:

yo mozu-actions:action

This will prompt you to add to your list of actions, and then will write the additional action scaffolds.