/generator-p

A minimal yeoman generator for npm packages.

Primary LanguageJavaScriptMIT LicenseMIT

generator-p Build Status js-standard-style

A minimal yeoman generator for npm packages. This is intended to cut out the majority of boilerplate required in creating a npm modules.

Installation

npm install -g generator-p

Usage

$ mkdir package-name && cd $_
$ yo p

You will then be prompted for some information that will be used to generate an npm package. This generator prompts you for:

  • Name
  • Github username
  • Twitter username
  • Package name
  • Package description

Using the information to create thorough package.json, index.js, license.md, test.js, and readme.md files with the following structure:

awesome-package/
  - test.js
  - .editorconfig
  - .gitignore
  - index.js
  - license
  - package.json
  - readme.md

This generator uses ava for tests and standard style.

License

MIT

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

Crafted with <3 by John Otander (@4lpine).