Data

Tools

Indexes

Applications

Experiments

Awesome

An open API service indexing awesome lists of open source software.

https://github.com/generate/generate-generator

Scaffold out a Generate generator project.
https://github.com/generate/generate-generator

Last synced: about 1 year ago
JSON representation

Scaffold out a Generate generator project.

Awesome Lists containing this project

README 

          












Generate a generate generator project, complete with unit tests.



# generate-generator



[![NPM version](https://img.shields.io/npm/v/generate-generator.svg?style=flat)](https://www.npmjs.com/package/generate-generator) [![NPM downloads](https://img.shields.io/npm/dm/generate-generator.svg?style=flat)](https://npmjs.org/package/generate-generator) [![Build Status](https://img.shields.io/travis/generate/generate-generator.svg?style=flat)](https://travis-ci.org/generate/generate-generator)



![generate-generator demo](https://raw.githubusercontent.com/generate/generate-generator/master/docs/demo.gif)



## Table of Contents



- [Tasks](#tasks)

  * [Running tasks](#running-tasks)

  * [Available tasks](#available-tasks)

- [Files trees](#files-trees)

  * [Generated files](#generated-files)

  * [Source files](#source-files)

- [What is "Generate"?](#what-is-generate)

- [Getting started](#getting-started)

  * [Install](#install)

  * [Usage](#usage)

  * [Help](#help)

- [Next steps](#next-steps)

  * [Running unit tests](#running-unit-tests)

  * [Publishing your generator](#publishing-your-generator)

- [About](#about)

  * [Related projects](#related-projects)

  * [Community](#community)

  * [Contributing](#contributing)

  * [Running tests](#running-tests)

  * [Author](#author)

  * [License](#license)



_(TOC generated by [verb](https://github.com/verbose/verb) using [markdown-toc](https://github.com/jonschlinkert/markdown-toc))_



## Tasks



### Running tasks



To run a task, just run `$ gen generator:` followed by the name of the task to run. For example, the following command will run the `minimal` task:



```sh

$ gen generator:minimal

```



### Available tasks



#### [generator:default](generator.js#L27)



Scaffold out a [generate](https://github.com/generate/generate) generator project. Alias for the [generator](#generator) task, to allow running the generator with the following command:



**Example**



```sh

$ gen generator

```



#### [generator:minimal](generator.js#L42)



Scaffold out a minimal [Generate](https://github.com/generate/generate) generator project.



**Example**



```sh

$ gen generator:min

## or

$ gen generator:minimal

```



#### [generator:micro](generator.js#L62)



Scaffold out a project for a [Generate](https://github.com/generate/generate) micro-generator.



**Example**



```sh

$ gen generator:micro

```



#### [generator:file](generator.js#L82)



Write a `generator.js` file to the current working directory.



**Example**



```sh

$ gen generator:file

```



#### [generator:main-micro](generator.js#L94)



Write the `generator.js` and `index.js` files for a micro-generator.



**Example**



```sh

$ gen generator:main-micro

```



#### [generator:rootfiles](generator.js#L106)



Generate the LICENSE, package.json and README.md files for a generator project.



**Example**



```sh

$ gen generator:rootfiles

```



#### [generator:test](generator.js#L123)



Write a `test.js` file to the current working directory, with unit tests for a [generate](https://github.com/generate/generate) generator.



**Example**



```sh

$ gen generator:test

```



#### [generator:templates](generator.js#L136)



Generate files in the generator's `templates` directory.



**Example**



```sh

$ gen generator:templates

```



#### [generator:prompt-git](generator.js#L148)



Initiates a prompt to ask if you'd like to initialize a git repository with first commit.



**Example**



```sh

$ gen generator:prompt-git

```



## Files trees



The following files trees are automatically generated by a task in [verbfile.js](verbfile.js).



* [dest files](#generated-files): trees representing the actual generated "dest" files for each task

* [source files](#source-files): trees representing the source files and templates used by each task



_(See Generate's [customization documentation](https://github.com/generate/generate/blob/master/docs/customization.md) to learn how to override individual templates.)_



### Generated files



> Files generated by each task



Diffs are base on files generated by the `default` task. Note that some tasks generate files that have different contents but the file path is unchanged (for example, the contents of `index.js` differs based on the task). These files won't show in the diff.



#### default



Files generated by the [default task](#default):



```diff

 .

 ├─┬ test

 │ ├── test.js

 │ └── plugin.js

 ├── .editorconfig

 ├── .eslintrc.json

 ├── .gitattributes

 ├── .gitignore

 ├── .travis.yml

 ├── generator.js

 ├── index.js

 ├── LICENSE

 ├── package.json

 └── README.md

```



#### micro



Files generated by the [micro task](#micro):



```diff

 .

 ├─┬ test

 │ ├── test.js

 │ └── plugin.js

 ├── .editorconfig

 ├── .eslintrc.json

 ├── .gitattributes

 ├── .gitignore

 ├── .travis.yml

 ├── generator.js

 ├── index.js

 ├── LICENSE

 ├── package.json

 └── README.md

```



#### minimal



Files generated by the [minimal task](#minimal):



```diff

 .

-├─┬ test

-│ ├── test.js

-│ └── plugin.js

-├── .editorconfig

-├── .eslintrc.json

-├── .gitattributes

 ├── .gitignore

-├── .travis.yml

 ├── generator.js

 ├── index.js

 ├── LICENSE

 ├── package.json

 └── README.md

```



#### files



Files generated by the [files task](#files):



```diff

 .

-├─┬ test

-│ ├── test.js

-│ └── plugin.js

 ├── .editorconfig

 ├── .eslintrc.json

 ├── .gitattributes

 ├── .gitignore

 ├── .travis.yml

-├── generator.js

-├── index.js

 ├── LICENSE

 ├── package.json

 └── README.md

```



#### rootfiles



Files generated by the [rootfiles task](#rootfiles):



```diff

 .

-├─┬ test

-│ ├── test.js

-│ └── plugin.js

-├── .editorconfig

-├── .eslintrc.json

-├── .gitattributes

-├── .gitignore

-├── .travis.yml

-├── generator.js

-├── index.js

 ├── LICENSE

 ├── package.json

 └── README.md

```



#### dotfiles



Files generated by the [dotfiles task](#dotfiles):



```diff

 .

-├─┬ test

-│ ├── test.js

-│ └── plugin.js

 ├── .editorconfig

 ├── .eslintrc.json

 ├── .gitattributes

 ├── .gitignore

 └── .travis.yml

-├── generator.js

-├── index.js

-├── LICENSE

-├── package.json

-└── README.md

```



#### index



Files generated by the [index task](#index):



```diff

 .

-├─┬ test

-│ ├── test.js

-│ └── plugin.js

-├── .editorconfig

-├── .eslintrc.json

-├── .gitattributes

-├── .gitignore

-├── .travis.yml

-├── generator.js

 └── index.js

-├── LICENSE

-├── package.json

-└── README.md

```



### Source files



> Source files or templates that are used by each task



#### default



Source files and/or libraries used by the [default task](#default):



```diff

 .

 ├─┬ templates

 │ ├─┬ tests

 │ │ ├── test.js

 │ │ └── plugin.js

 │ ├── generator.js

 │ └── index.js

 └─┬ node_modules

   ├─┬ generate-editorconfig

   │ └─┬ templates

   │   └── _editorconfig

   ├─┬ generate-eslint

   │ └─┬ templates

   │   └── _eslintrc.json

   ├─┬ generate-gitattributes

   │ └─┬ templates

   │   └── _gitattributes

   ├─┬ generate-gitignore

   │ └─┬ templates

   │   └── Minimal.gitignore

   ├─┬ generate-travis

   │ └─┬ templates

   │   └── _travis.yml

   ├─┬ generate-license

   │ └─┬ templates

   │   └── mit.tmpl

   ├─┬ generate-package

   │ └─┬ templates

   │   └── $package.json

   └─┬ generate-readme

     └─┬ templates

       └── node.md

```



#### micro



Source files and/or libraries used by the [micro task](#micro):



```diff

 .

 ├─┬ templates

 │ ├─┬ tests

 │ │ ├── test.js

 │ │ └── plugin.js

 │ ├── generator-micro.js

 │ └── index.js

 └─┬ node_modules

   ├─┬ generate-editorconfig

   │ └─┬ templates

   │   └── _editorconfig

   ├─┬ generate-eslint

   │ └─┬ templates

   │   └── _eslintrc.json

   ├─┬ generate-gitattributes

   │ └─┬ templates

   │   └── _gitattributes

   ├─┬ generate-gitignore

   │ └─┬ templates

   │   └── Minimal.gitignore

   ├─┬ generate-travis

   │ └─┬ templates

   │   └── _travis.yml

   ├─┬ generate-license

   │ └─┬ templates

   │   └── mit.tmpl

   ├─┬ generate-package

   │ └─┬ templates

   │   └── $package.json

   └─┬ generate-readme

     └─┬ templates

       └── node.md

```



#### minimal



Source files and/or libraries used by the [minimal task](#minimal):



```diff

 .

 ├─┬ node_modules

 │ ├─┬ generate-gitignore

 │ │ └─┬ templates

 │ │   └── Node.gitignore

 │ ├─┬ generate-license

 │ │ └─┬ templates

 │ │   └── mit.tmpl

 │ ├─┬ generate-package

 │ │ └─┬ templates

 │ │   └── $package.json

 │ └─┬ generate-readme

 │   └─┬ templates

 │     └── node.md

 └─┬ templates

   ├── generator.js

   └── index.js

```



#### files



Source files and/or libraries used by the [files task](#files):



```diff

 .

 └─┬ node_modules

   ├─┬ generate-editorconfig

   │ └─┬ templates

   │   └── _editorconfig

   ├─┬ generate-eslint

   │ └─┬ templates

   │   └── _eslintrc.json

   ├─┬ generate-gitattributes

   │ └─┬ templates

   │   └── _gitattributes

   ├─┬ generate-gitignore

   │ └─┬ templates

   │   └── Minimal.gitignore

   ├─┬ generate-travis

   │ └─┬ templates

   │   └── _travis.yml

   ├─┬ generate-license

   │ └─┬ templates

   │   └── mit.tmpl

   ├─┬ generate-package

   │ └─┬ templates

   │   └── $package.json

   └─┬ generate-readme

     └─┬ templates

       └── node.md

```



#### rootfiles



Source files and/or libraries used by the [rootfiles task](#rootfiles):



```diff

 .

 └─┬ node_modules

   ├─┬ generate-license

   │ └─┬ templates

   │   └── mit.tmpl

   ├─┬ generate-package

   │ └─┬ templates

   │   └── $package.json

   └─┬ generate-readme

     └─┬ templates

       └── node.md

```



#### dotfiles



Source files and/or libraries used by the [dotfiles task](#dotfiles):



```diff

 .

 └─┬ node_modules

   ├─┬ generate-editorconfig

   │ └─┬ templates

   │   └── _editorconfig

   ├─┬ generate-eslint

   │ └─┬ templates

   │   └── _eslintrc.json

   ├─┬ generate-gitattributes

   │ └─┬ templates

   │   └── _gitattributes

   ├─┬ generate-gitignore

   │ └─┬ templates

   │   └── Minimal.gitignore

   └─┬ generate-travis

     └─┬ templates

       └── _travis.yml

```



#### index



Source files and/or libraries used by the [index task](#index):



```diff

 .

 └─┬ node_modules

   └─┬ generate-project

     └─┬ templates

       └── index.js

```



## What is "Generate"?



Generate is a command line tool and developer framework for scaffolding out new GitHub projects using [generators](https://github.com/generate/generate/blob/master/docs/generators.md) and [tasks](https://github.com/generate/generate/blob/master/docs/tasks.md).



Answers to prompts and the user's environment can be used to determine the templates, directories, files and contents to build. Support for [gulp](http://gulpjs.com), [base](https://github.com/node-base/base) and [assemble](https://github.com/assemble/assemble) plugins, and much more.



**For more information**:



* Visit the [generate project](https://github.com/generate/generate/)

* Visit the [generate documentation](https://github.com/generate/generate/blob/master/docs/)

* Find [generators on npm](https://www.npmjs.com/browse/keyword/generate-generator) (help us [author generators](https://github.com/generate/generate/blob/master/docs/micro-generators.md))



## Getting started



### Install



**Installing the CLI**



To run the `generator` generator from the command line, you'll need to install [Generate](https://github.com/generate/generate) globally first. You can do that now with the following command:



```sh

$ npm install --global generate

```



This adds the `gen` command to your system path, allowing it to be run from any directory.



**Install generate-generator**



Install this module with the following command:



```sh

$ npm install --global generate-generator

```



### Usage



Run this generator's `default` [task](https://github.com/generate/generate/blob/master/docs/tasks.md#default) with the following command:



```sh

$ gen generator

```



**What you should see in the terminal**



If completed successfully, you should see both `starting` and `finished` events in the terminal, like the following:



```sh

[00:44:21] starting ...

...

[00:44:22] finished ✔

```



If you do not see one or both of those events, please [let us know about it](../../issues).



### Help



To see a general help menu and available commands for Generate's CLI, run:



```sh

$ gen help

```



## Next steps



### Running unit tests



It's never too early to begin running unit tests. When you're ready to get started, the following command will ensure the project's dependencies are installed then run all of the unit tests:



```sh

$ npm install && test

```



### Publishing your generator



If you're tests are passing and you're ready to publish your generator to [npm](https://www.npmjs.com), you can do that now with the following command:



**Are you sure you're ready?!**



Let's go!



```sh

$ npm publish

```



## About



### Related projects



[generate](https://www.npmjs.com/package/generate): Command line tool and developer framework for scaffolding out new GitHub projects. Generate offers the… [more](https://github.com/generate/generate) | [homepage](https://github.com/generate/generate "Command line tool and developer framework for scaffolding out new GitHub projects. Generate offers the robustness and configurability of Yeoman, the expressiveness and simplicity of Slush, and more powerful flow control and composability than either.")



### Community



Are you using [Generate](https://github.com/generate/generate) in your project? Have you published a [generator](https://github.com/generate/generate/blob/master/docs/generators.md) and want to share your project with the world?



Here are some suggestions!



* If you get like Generate and want to tweet about it, please feel free to mention `@generatejs` or use the `#generatejs` hashtag

* Show your love by starring [Generate](https://github.com/generate/generate) and `generate-generator`

* Get implementation help on [StackOverflow](http://stackoverflow.com/questions/tagged/generate) (please use the `generatejs` tag in questions)

* **Gitter** Discuss Generate with us on [Gitter](https://gitter.im/generate/generate)

* If you publish an generator, thank you! To make your project as discoverable as possible, please add the keyword `generategenerator` to package.json.



### Contributing



Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).



### Running tests



Install dev dependencies:



```sh

$ npm install -d && npm test

```



### Author



**Jon Schlinkert**



* [github/jonschlinkert](https://github.com/jonschlinkert)

* [twitter/jonschlinkert](http://twitter.com/jonschlinkert)



### License



Copyright © 2016, [Jon Schlinkert](https://github.com/jonschlinkert).

Released under the MIT license.



***



_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.1.30, on August 18, 2016._