https://github.com/johno/generator-p

A minimal yeoman generator for npm packages.
https://github.com/johno/generator-p

Last synced: 3 months ago
JSON representation

A minimal yeoman generator for npm packages.

• Host: GitHub
• URL: https://github.com/johno/generator-p
• Owner: johno
• License: mit
• Created: 2015-01-06T21:12:21.000Z (about 10 years ago)
• Default Branch: master
• Last Pushed: 2016-06-26T23:00:29.000Z (over 8 years ago)
• Last Synced: 2024-04-14T05:32:58.350Z (10 months ago)
• Language: JavaScript
• Size: 40 KB
• Stars: 19
• Watchers: 4
• Forks: 6
• Open Issues: 3
• Metadata Files:
  • Readme: readme.md
  • License: license

Awesome Lists containing this project

README

        
# generator-p [![Build Status](https://secure.travis-ci.org/johnotander/generator-p.png?branch=master)](https://travis-ci.org/johnotander/generator-p) [![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat)](https://github.com/feross/standard)

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

## Installation

```bash

npm install -g generator-p

```

## Usage

```bash

$ 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](https://github.com/sindresorhus/ava) for tests and [standard](https://github.com/feross/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](http://johnotander.com) ([@4lpine](https://twitter.com/4lpine)).