Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/generate/generate-install
Generator that automatically detects the dependencies or devDependencies to install based on the templates or includes used. This can be used as a sub-generator or plugin in your own generator.
https://github.com/generate/generate-install
generate generator install javascript nodejs npm plugin
Last synced: about 4 hours ago
JSON representation
Generator that automatically detects the dependencies or devDependencies to install based on the templates or includes used. This can be used as a sub-generator or plugin in your own generator.
- Host: GitHub
- URL: https://github.com/generate/generate-install
- Owner: generate
- License: mit
- Created: 2016-06-21T13:13:09.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2017-09-25T19:31:18.000Z (about 7 years ago)
- Last Synced: 2024-10-06T19:46:51.087Z (about 1 month ago)
- Topics: generate, generator, install, javascript, nodejs, npm, plugin
- Language: JavaScript
- Size: 30.3 KB
- Stars: 7
- Watchers: 3
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# generate-install [](https://www.npmjs.com/package/generate-install) [](https://npmjs.org/package/generate-install) [](https://npmjs.org/package/generate-install) [](https://travis-ci.org/generate/generate-install) [](https://ci.appveyor.com/project/generate/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"?](#what-is-generate)
- [How does generate-install work?](#how-does-generate-install-work)
* [1. middleware](#1-middleware)
* [2. prompt](#2-prompt)
- [Tasks](#tasks)
- [About](#about)
* [Related projects](#related-projects)
* [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))_
## 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))
## How does generate-install work?
This generator can be [installed](#install) as a dependency and registered with the `.use` method in your own generator.
**Install**
Install with [npm](https://www.npmjs.com/):
```sh
$ npm install generate-install
```
**Example usage**
In your own [generator](https://github.com/generate/generate/blob/master/docs/generators.md):
```js
module.exports = function(app) {
app.use(require('generate-install'));
};
```
Once registered, generate-install does two things:
* [middleware](#middleware): Adds a middleware for getting dependencies to install
* [prompt](#prompt): Adds a task for prompting the user to install the detected dependencies
### 1. middleware
Adds a `.postWrite` [middleware](https://github.com/generate/generate/blob/master/docs/middleware.md), which runs after a file is written to the file system to see if an `install` object was defined in [yaml front-matter](https://github.com/generate/generate/blob/master/docs/front-matter.md)).
**Example**
This example shows a basic `gulpfile.js` template with front-matter that defines `gulp` as a dev dependency.
```js
---
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:
```js
---
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](#tasks) for prompting the user.
**Example usage**
Run after other tasks are finished:
```js
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:
```sh
gen foo install
```
## Tasks
Visit Generate's [task documentation](https://github.com/generate/generate/blob/master/docs/tasks.md).
## About
### Related projects
* [generate-eslint](https://www.npmjs.com/package/generate-eslint): Generate a new `.eslintrc.json` or `.eslintignore` file from a pre-defined or user-defined template. Can be… [more](https://github.com/generate/generate-eslint) | [homepage](https://github.com/generate/generate-eslint "Generate a new `.eslintrc.json` or `.eslintignore` file from a pre-defined or user-defined template. Can be used from the command line when installed globally, or as a plugin in your own generator.")
* [generate-license](https://www.npmjs.com/package/generate-license): Generate a license file for a GitHub project. | [homepage](https://github.com/generate/generate-license "Generate a license file for a GitHub project.")
* [generate-package](https://www.npmjs.com/package/generate-package): Generate a package.json from a pre-defined or user-defined template. This generator can be used from… [more](https://github.com/generate/generate-package) | [homepage](https://github.com/generate/generate-package "Generate a package.json from a pre-defined or user-defined template. This generator can be used from the command line when globally installed, or as a plugin or sub-generator in your own generator.")
* [generate-travis](https://www.npmjs.com/package/generate-travis): Generate a .travis.yml file to the cwd or specified directory. Install globally and run with… [more](https://github.com/generate/generate-travis) | [homepage](https://github.com/generate/generate-travis "Generate a .travis.yml file to the cwd or specified directory. Install globally and run with generate's CLI, or use as a component in your own generator.")
### Contributing
Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).
### 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:
```sh
$ npm install && npm test
```
### Author
**Jon Schlinkert**
* [github/jonschlinkert](https://github.com/jonschlinkert)
* [twitter/jonschlinkert](https://twitter.com/jonschlinkert)
### License
Copyright © 2017, [Jon Schlinkert](https://github.com/jonschlinkert).
Released under the [MIT License](LICENSE).
***
_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.6.0, on September 25, 2017._