# generate-collections

> Initializes a handful of (empty) template collections to your generator, such as docs, includes, badges, and layouts, along with a few generic defaults.

Latest version **0.3.9** (published 2017-05-27) · MIT license · 0 weekly downloads

## Install

```sh
npm install generate-collections
pnpm add generate-collections
yarn add generate-collections
bun add generate-collections
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.3.9 |
| Published | 2017-05-27 |
| First published | 2016-02-14 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=0.10.0 |
| Dependencies | 6 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 6 |
| Author | Jon Schlinkert |
| Maintainers | jonschlinkert |
| Keywords | boilerplate, build, cli, cli-app, collections, command-line, create, dev, development, framework, front, frontend, generate, generate-generator, generate-plugin, generategenerator, generateplugin, generator, init, initialize, new, plugin, project, projects, scaffold, scaffolder, scaffolding, template, templates, verb, verb-generator, verbgenerator, webapp, yeoman, yo |

## Links

- npm: https://www.npmjs.com/package/generate-collections
- Repository: https://github.com/generate/generate-collections
- Issues: https://github.com/generate/generate-collections/issues
- npm.io page: https://npm.io/package/generate-collections

## Dependencies (6)

- [falsey](https://npm.io/package/falsey.md) ^0.3.0
- [isobject](https://npm.io/package/isobject.md) ^3.0.0
- [lazy-cache](https://npm.io/package/lazy-cache.md) ^2.0.2
- [is-valid-app](https://npm.io/package/is-valid-app.md) ^0.3.0
- [extend-shallow](https://npm.io/package/extend-shallow.md) ^2.0.1
- [parser-front-matter](https://npm.io/package/parser-front-matter.md) ^1.6.3

## Alternatives

- [@salesforce/cli](https://npm.io/package/@salesforce/cli.md) — 389.7K weekly downloads
- [@mintlify/cli](https://npm.io/package/@mintlify/cli.md) — 208.9K weekly downloads
- [@grafana/e2e-selectors](https://npm.io/package/@grafana/e2e-selectors.md) — 128.7K weekly downloads
- [mintlify](https://npm.io/package/mintlify.md) — 112.0K weekly downloads
- [@intlayer/cli](https://npm.io/package/@intlayer/cli.md) — 22.8K weekly downloads

## Recent versions

- 0.3.9 (latest) — 2017-05-27
- 0.3.8 — 2017-05-27
- 0.3.7 — 2017-01-27
- 0.3.6 — 2016-08-09
- 0.3.5 — 2016-06-28
- 0.3.4 — 2016-06-21
- 0.3.3 — 2016-06-21
- 0.3.2 — 2016-06-21
- 0.3.1 — 2016-06-21
- 0.3.0 — 2016-06-21
- 0.2.1 — 2016-04-17
- 0.2.0 — 2016-03-29
- 0.1.5 — 2016-03-06
- 0.1.4 — 2016-03-05
- 0.1.3 — 2016-02-23
- … 3 more at https://npm.io/package/generate-collections/versions

## README

# generate-collections [![NPM version](https://img.shields.io/npm/v/generate-collections.svg?style=flat)](https://www.npmjs.com/package/generate-collections) [![NPM monthly downloads](https://img.shields.io/npm/dm/generate-collections.svg?style=flat)](https://npmjs.org/package/generate-collections) [![NPM total downloads](https://img.shields.io/npm/dt/generate-collections.svg?style=flat)](https://npmjs.org/package/generate-collections) [![Linux Build Status](https://img.shields.io/travis/generate/generate-collections.svg?style=flat&label=Travis)](https://travis-ci.org/generate/generate-collections)

> Initializes a handful of (empty) template collections to your generator, such as docs, includes, badges, and layouts, along with a few generic defaults.

You might also be interested in [generate-file](https://github.com/generate/generate-file).

## Install

Install as a `devDependency` with [npm](https://www.npmjs.com/):

```sh
$ npm install --save-dev generate-collections
```

## Usage

Use as a plugin, to initialize commonly used [view collections](#collections-created) (no views are actually added to the collections).

```js
module.exports = function(app) {
  app.use(require('generate-collections'));
  // do other generator stuff
};
```

## Collections created

Adds the following view collections to your generator:

### Renderable

Templates for files intended to be written to the file system.

* `files`

**Example usage**

```js
app.files('templates/*.md');
```

### Layouts

Templates to be used as layouts (for "wrapping" other templates or content):

* `layouts`

```js
app.layouts('templates/layouts/*.md');
```

### Partials

Templates to be used as partials (for injecting into other templates)

* `includes`
* `badges`
* `docs`

```js
app.partials('templates/partials/*.md');
```

## Smart plugin

This generator follows [base](https://github.com/node-base/base) "smart plugin" conventions, so it can be used as a plugin with any of the following libraries:

* [generate](https://github.com/generate/generate): in your local `generator.js` file or globally installed `generate` generator.
* [assemble](https://github.com/assemble/assemble): in your local `assemblefile.js` file or globally installed `assemble` generator.
* [update](https://github.com/update/update): in your local `updatefile.js` file or globally installed `update` generator.
* [verb](https://github.com/verbose/verb): in your local `verbfile.js` file or globally installed `verb` generator.

## About

### Related projects

* [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-mocha](https://www.npmjs.com/package/generate-mocha): Generate mocha test files. | [homepage](https://github.com/generate/generate-mocha "Generate mocha test files.")
* [generate-node](https://www.npmjs.com/package/generate-node): Generate a node.js project, with everything you need to begin writing code and easily publish… [more](https://github.com/generate/generate-node) | [homepage](https://github.com/generate/generate-node "Generate a node.js project, with everything you need to begin writing code and easily publish the project to npm.")

### Contributing

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

### Building docs

_(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_

To generate the readme, run the following command:

```sh
$ npm install -g verbose/verb#dev verb-generate-readme && verb
```

### 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 May 27, 2017._

---
_Source: https://npm.io/package/generate-collections · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._