generate-install

generate-install

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?
  • 1. middleware
  • 2. prompt
• Tasks
• About
  • Related projects
  • Contributing
  • Running tests
  • Author
  • License

(TOC generated by verb using markdown-toc)

What is "Generate"?

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:

• 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

Install with npm:

$ npm install generate-install

Example usage

In your own generator:

module.exports = function(app) {
  app.use(require('generate-install'));
};

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

1. middleware

Adds a .postWrite middleware, which runs after a file is written to the file system to see if an install object was defined in yaml front-matter).

Example

This example shows a basic gulpfile.js template with front-matter that defines gulp as a dev dependency.

---
install:
  devDependencies: ['gulp']
---
var gulp = require('gulp');

gulp.task('default', function(cb) {
  // do task stuff
  cb();
});

If the install object exists, the middleware will extract the dependencies and devDependencies, filtering out any deps that are already installed and listed in package.json.

This also works:

---
install: ['gulp']
---
var gulp = require('gulp');

gulp.task('default', function(cb) {
  // do task stuff
  cb();
});

Which is normalize to {devDependencies: ['gulp']}.

2. prompt

The second thing this generator adds is an optional task for prompting the user.

Example usage

Run after other tasks are finished:

app.use(require('generate-install'));
app.task('generate-stuff', function(cb) {
  cb();
});

app.generate(['generate-stuff', 'install'], function(err) {
  if (err) return console.log(err);
});

This task is optional, since the user can also install this generator globally and run is directly.

Example

If your generate is named foo, the user can do this:

gen foo install

Tasks

Visit Generate's task documentation.

About

Related projects

• generate-eslint: Generate a new .eslintrc.json or .eslintignore file 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

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Running tests

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

Author

Jon Schlinkert

• github/jonschlinkert
• twitter/jonschlinkert

License

Copyright © 2017, Jon Schlinkert. Released under the MIT License.

This file was generated by verb-generate-readme, v0.6.0, on September 25, 2017.