https://github.com/stylesuxx/generator-minimal-generator

Yeoman generator that generates a minimal yeoman generator
https://github.com/stylesuxx/generator-minimal-generator

Last synced: about 1 month ago
JSON representation

Yeoman generator that generates a minimal yeoman generator

• Host: GitHub
• URL: https://github.com/stylesuxx/generator-minimal-generator
• Owner: stylesuxx
• Created: 2015-11-13T20:14:18.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2015-12-23T16:29:54.000Z (almost 9 years ago)
• Last Synced: 2024-04-29T13:22:04.118Z (7 months ago)
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/generator-minimal-generator
• Size: 20.5 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Generator Minimal Generator

[![npm version](https://badge.fury.io/js/generator-minimal-generator.svg)](https://badge.fury.io/js/generator-minimal-generator) [![Build pass](https://travis-ci.org/stylesuxx/generator-minimal-generator.svg?branch=master)](https://travis-ci.org/stylesuxx/generator-minimal-generator?branch=master)  [![Dependencies](https://david-dm.org/stylesuxx/generator-minimal-generator.svg)](https://david-dm.org/stylesuxx/generator-minimal-generator) [![devDependency Status](https://david-dm.org/stylesuxx/generator-minimal-generator/dev-status.svg)](https://david-dm.org/stylesuxx/generator-minimal-generator#info=devDependencies)

>A yeoman generator that generates a minimal yeoman generator without introducing any dependencies you do not need.

## Installation

Install the generator globally:

    sudo npm install generator-minimal-generator -g

## Usage

To invoke the generator create a directory for the generator and run it:

    mkdir generator-my-generator

    yo minimal-generator

## Structure

After invoking the generator you are left with a yeoman generator project with the following folder structure:

    project-root

    ├── .gitignore

    ├── package.json

    ├── README.md

    └── app

        └── index.js

## First Steps

After generation you are left with a minimal generator that only prompts for app name. All default yeoman  [contexts](http://yeoman.io/authoring/running-context.html) are available in *app/index.js* and are mostly empty.

If you are not yet fond of yeoman generator development I highly suggest to go through the excellent [yeoman documentation](http://yeoman.io/authoring/).

## Development

If you find a bug or run into any problems with this generator feel free to post to the issue section. If you made an addition I would be happy to see a PR for it.

## [MIT](https://opensource.org/licenses/MIT) License

Copyright (c) 2105 Chris Landa

Permission is hereby granted, free of charge, to any person obtaining a copy

of this software and associated documentation files (the "Software"), to deal

in the Software without restriction, including without limitation the rights

to use, copy, modify, merge, publish, distribute, sublicense, and/or sell

copies of the Software, and to permit persons to whom the Software is

furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in

all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,

FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE

AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER

LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,

OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN

THE SOFTWARE.