Generator-hapi-plugin NPM

Hapi.js plugin generator

This generator creates a new hapi plugin with all the boilerplate you need to get started.

Features

Hapi plugin boilerplate
Unit testing and code coverage with Lab
Code linting
Watch tasks for tests and development server
JavaScript code style check (optional)
Npm versioning (optional)

Installation

Install the generator by running: npm install -g generator-hapi-plugin

Usage

Make a new directory, and cd into it. Run the following command and follow the prompts.

yo hapi-plugin

Note that this template will generate files in the current directory, so be sure to first change to a new directory if you don't want to overwrite existing files.

Development

Run the following command from the root of the project:

gulp develop

The develop task starts a development hapi server which requires your plugin. The server gets restarted on changes made in your project folder.

Release

gulp bump

The bump task increments the plugin version in the package.json file on a patch base. You can use the type parameter to specify the type of release:

gulp bump --type (major|minor|patch|prerelease)

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using gulp.