$ npm install generate-generator
Generate a generate generator project, complete with unit tests.
(TOC generated by verb using markdown-toc)
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:
$ gen generator:minimal
Scaffold out a generate generator project. Alias for the generator task, to allow running the generator with the following command:
Example
$ gen generator
Scaffold out a minimal Generate generator project.
Example
$ gen generator:min
## or
$ gen generator:minimal
Scaffold out a project for a Generate micro-generator.
Example
$ gen generator:micro
Write a generator.js file to the current working directory.
Example
$ gen generator:file
Write the generator.js and index.js files for a micro-generator.
Example
$ gen generator:main-micro
Generate the LICENSE, package.json and README.md files for a generator project.
Example
$ gen generator:rootfiles
Write a test.js file to the current working directory, with unit tests for a generate generator.
Example
$ gen generator:test
Generate files in the generator's templates directory.
Example
$ gen generator:templates
Initiates a prompt to ask if you'd like to initialize a git repository with first commit.
Example
$ gen generator:prompt-git
The following files trees are automatically generated by a task in verbfile.js.
(See Generate's customization documentation to learn how to override individual templates.)
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.
Files generated by the default task:
.
├─┬ test
│ ├── test.js
│ └── plugin.js
├── .editorconfig
├── .eslintrc.json
├── .gitattributes
├── .gitignore
├── .travis.yml
├── generator.js
├── index.js
├── LICENSE
├── package.json
└── README.md
Files generated by the micro task:
.
├─┬ test
│ ├── test.js
│ └── plugin.js
├── .editorconfig
├── .eslintrc.json
├── .gitattributes
├── .gitignore
├── .travis.yml
├── generator.js
├── index.js
├── LICENSE
├── package.json
└── README.md
Files generated by the minimal task:
.
-├─┬ test
-│ ├── test.js
-│ └── plugin.js
-├── .editorconfig
-├── .eslintrc.json
-├── .gitattributes
├── .gitignore
-├── .travis.yml
├── generator.js
├── index.js
├── LICENSE
├── package.json
└── README.md
Files generated by the files task:
.
-├─┬ test
-│ ├── test.js
-│ └── plugin.js
├── .editorconfig
├── .eslintrc.json
├── .gitattributes
├── .gitignore
├── .travis.yml
-├── generator.js
-├── index.js
├── LICENSE
├── package.json
└── README.md
Files generated by the rootfiles task:
.
-├─┬ test
-│ ├── test.js
-│ └── plugin.js
-├── .editorconfig
-├── .eslintrc.json
-├── .gitattributes
-├── .gitignore
-├── .travis.yml
-├── generator.js
-├── index.js
├── LICENSE
├── package.json
└── README.md
Files generated by the dotfiles task:
.
-├─┬ test
-│ ├── test.js
-│ └── plugin.js
├── .editorconfig
├── .eslintrc.json
├── .gitattributes
├── .gitignore
└── .travis.yml
-├── generator.js
-├── index.js
-├── LICENSE
-├── package.json
-└── README.md
Files generated by the index task:
.
-├─┬ test
-│ ├── test.js
-│ └── plugin.js
-├── .editorconfig
-├── .eslintrc.json
-├── .gitattributes
-├── .gitignore
-├── .travis.yml
-├── generator.js
└── index.js
-├── LICENSE
-├── package.json
-└── README.md
Source files or templates that are used by each task
Source files and/or libraries used by the default task:
.
├─┬ 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
Source files and/or libraries used by the micro task:
.
├─┬ 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
Source files and/or libraries used by the minimal task:
.
├─┬ 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
Source files and/or libraries used by the files task:
.
└─┬ 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
Source files and/or libraries used by the rootfiles task:
.
└─┬ node_modules
├─┬ generate-license
│ └─┬ templates
│ └── mit.tmpl
├─┬ generate-package
│ └─┬ templates
│ └── $package.json
└─┬ generate-readme
└─┬ templates
└── node.md
Source files and/or libraries used by the dotfiles task:
.
└─┬ 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
Source files and/or libraries used by the index task:
.
└─┬ node_modules
└─┬ generate-project
└─┬ templates
└── index.js
Generate is a command line tool and developer framework for scaffolding out new GitHub projects using generators and tasks.
Answers to prompts and the user's environment can be used to determine the templates, directories, files and contents to build. Support for gulp, base and assemble plugins, and much more.
For more information:
Installing the CLI
To run the generator generator from the command line, you'll need to install Generate globally first. You can do that now with the following command:
$ 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:
$ npm install --global generate-generator
Run this generator's default task with the following command:
$ 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:
[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.
To see a general help menu and available commands for Generate's CLI, run:
$ gen help
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:
$ npm install && test
If you're tests are passing and you're ready to publish your generator to npm, you can do that now with the following command:
Are you sure you're ready?!
Let's go!
$ npm publish
generate: Command line tool and developer framework for scaffolding out new GitHub projects. Generate offers the… more | homepage
Are you using Generate in your project? Have you published a generator and want to share your project with the world?
Here are some suggestions!
@generatejs or use the #generatejs hashtaggenerate-generatorgeneratejs tag in questions)generategenerator to package.json.Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
Install dev dependencies:
$ npm install -d && npm test
Jon Schlinkert
Copyright © 2016, Jon Schlinkert. Released under the MIT license.
This file was generated by verb-generate-readme, v0.1.30, on August 18, 2016.