generate-collections

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.

Install

Install as a devDependency with npm:

$ npm install --save-dev generate-collections

Usage

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

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

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

Layouts

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

• layouts

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

Partials

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

• includes
• badges
• docs

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

Smart plugin

This generator follows base "smart plugin" conventions, so it can be used as a plugin with any of the following libraries:

• generate: in your local generator.js file or globally installed generate generator.
• assemble: in your local assemblefile.js file or globally installed assemble generator.
• update: in your local updatefile.js file or globally installed update generator.
• verb: in your local verbfile.js file or globally installed verb generator.

About

Related projects

• generate-license: Generate a license file for a GitHub project. | homepage
• generate-mocha: Generate mocha test files. | homepage
• generate-node: Generate a node.js project, with everything you need to begin writing code and easily publish… more | homepage

Contributing

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

Building docs

(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)

To generate the readme, run the following command:

$ 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:

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