JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 24953
  • Score
    100M100P100Q126383F
  • License MIT

Fast, composable, highly extendable project generator with a user-friendly and expressive API.

Package Exports

  • generate

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (generate) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

generate NPM version Build Status

Fast, composable, highly extendable project generator with a user-friendly and expressive API.

You might also be interested in verb.

TOC

(TOC generated by verb using markdown-toc)

Install

Install globally with npm

$ npm install -g generate

What is generate?

Generate is a fast, highly pluggable project generator, with a user-friendly CLI and an expressive API.

Feature Highlights

  • Run local or globally-installed generators
  • Run sub-generators using simple dot-notation. Supports any level of nesting!
  • Run gulp-style "tasks" and uses some of the same underlying libraries as gulp
  • Built on assemble-core with support for both gulp and assemble plugins
  • Generators can extend and use other generators
  • Generators, sub-generators and tasks can be run by command line, API, or both.
  • Run tasks from any generator or sub-generator, programmatically or via CLI
  • Easy to add functionality and features to generate using via plugins
  • Supports any template engine
  • First class support for template collections, including pagination, sorting, groups, and more.
  • supports middleware that can be run on all files or specific files, and at specific points during the build process (like onLoad, preRender, postRender, etc)

Generate is also well-tested, with close to 1200 unit tests.

Quickstart

1. generator.js

Create a generator.js file, and add the following code:

module.exports = function(app) {
  app.task('default', function(cb) {
    console.log('task > default');
    cb();
  });

  app.task('foo', function(cb) {
    console.log('task > foo');
    cb();
  });
};

2. Run gen

In the command line run:

  • gen to execute the default task
  • gen foo to execute the foo task
  • assemble: Assemble is a powerful, extendable and easy to use static site generator for node.js. Used… more | homepage
  • base: base is the foundation for creating modular, unit testable and highly pluggable node.js applications, starting… more | homepage
  • update: Easily keep anything in your project up-to-date by installing the updaters you want to use… more | homepage
  • verb: Documentation generator for GitHub projects. Verb is extremely powerful, easy to use, and is used… more | homepage

Generate docs

Generate readme and API documentation with verb:

$ npm install verb && npm run docs

Or, if verb is installed globally:

$ verb

Running tests

Install dev dependencies:

$ npm install -d && npm test

Contributing

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

Author

Jon Schlinkert

License

Copyright © 2016 Jon Schlinkert Released under the MIT license.

This file was generated by verb, v0.9.0, on February 23, 2016.