generator-hapi-plugin

Hapi.js Plugin generator

Based of generator-node

This generator creates a new Node.js module, generating all the boilerplate you need to get started with best-of-breed form the gulp ecosystem. The generator also optionally installs additional gulp plugins, ee the list below.

Installation

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

Features

• Customize dependencies prompt by editing the settings.json file see.
• Prefill prompt with the last used values for
  • GitHub username
  • Author's Name
  • Author's Email
  • Author's Homepage

devDependencies

• Mocha Unit Testing with gulp-mocha
• Automagically lint your code with gulp-jshint
• Optional – Check JavaScript code style with gulp-jscs
• Optional – Measuring code coverage with gulp-istanbul
• Optional – Upload LCOV data to coveralls.io with coveralls
• Optional – Bump npm versions with gulp-bump

dependencies

You can customize the dependencies prompt with your preferred one by editing the settings.json. The file is located in the root of the generator-hapi-plugin /usr/local/lib/node_modules/generator-hapi-plugin/.

• debug
• Lo-Dash
• q

settings.json

By default, the file looks something like this.

{
  "meta": {
    "githubUsername": "kwakayama",
    "authorName": "Kentaro Wakayama",
    "authorEmail": "[e-mail]",
    "authorUrl": "www.wakayama.io"
  },
  "dependencies": [
    {
      "name": "lodash",
      "description": "A utility library"
    },
    {
      "name": "q",
      "description": "A library for promises"
    },
    {
      "name": "debug",
      "description": "tiny node.js debugging utility"
    }
  ]
}

Usage

At the command-line, cd into an empty directory, run this command and follow the prompts.

yo hapi-plugin

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

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.

Support

Should you have any problems or wishes for improvements, feel free to open up an issue.

License

Copyright (c) 2014 Kentaro Wakayama. Licensed under the MIT License.