Generator that automatically detects the dependencies or devDependencies to install based on the templates or includes that are dynamically used by your generator. This can be used as a sub-generator or plugin in your own generator.
Table of Contents
- What is "Generate"?
- How does generate-install work?
What is "Generate"?
For more information:
- Visit the generate project
- Visit the generate documentation
- Find generators on npm (help us author generators)
How does generate-install work?
This generator can be installed as a dependency and registered with the
.use method in your own generator.
Install with npm:
$ npm install generate-install
In your own generator:
Once registered, generate-install does two things:
- middleware: Adds a middleware for getting dependencies to install
- prompt: Adds a task for prompting the user to install the detected dependencies
This example shows a basic
gulpfile.js template with front-matter that defines
gulp as a dev dependency.
---install:devDependencies: 'gulp'---var gulp = ;gulp;
install object exists, the middleware will extract the
devDependencies, filtering out any deps that are already installed and listed in
This also works:
---install: 'gulp'---var gulp = ;gulp;
Which is normalize to
The second thing this generator adds is an optional task for prompting the user.
Run after other tasks are finished:
This task is optional, since the user can also install this generator globally and run is directly.
If your generate is named
foo, the user can do this:
gen foo install
Visit Generate's task documentation.
- generate-eslint: Generate a new
.eslintignorefile from a pre-defined or user-defined template. Can be… more | homepage
- generate-license: Generate a license file for a GitHub project. | homepage
- generate-package: Generate a package.json from a pre-defined or user-defined template. This generator can be used from… more | homepage
- generate-travis: Generate a .travis.yml file to the cwd or specified directory. Install globally and run with… more | homepage
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:
$ npm install && npm test
This file was generated by verb-generate-readme, v0.6.0, on September 25, 2017.