Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Yeoman Generators
JavaScript
Branch: master
Pull request Compare This branch is 5 commits ahead, 372 commits behind yeoman:master.

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
benchmark
lib
test
.editorconfig
.gitattributes
.gitignore
.jscs.json
.jshintignore
.jshintrc
.npmignore
.travis.yml
gulpfile.js
jsdoc.json
main.js Improve jsdoc markup
package.json
readme.md

readme.md

Generator Build Status Coverage Status

A Rails-inspired generator system that provides scaffolding for your apps.

Getting Started   API Documentation

Generator output

Generator diff

Getting Started

If you're interested in writing your own Yeoman generator we recommend reading the official getting started guide.

There are typically two types of generators - simple boilerplate 'copiers' and more advanced generators which can use custom prompts, remote dependencies, wiring and much more.

The docs cover how to create generators from scratch as well as recommending command-line generators for making other generators.

For deeper research, read the code source or visit our API documentation.

Testing generators

There is currently no formal infrastructure for testing generators, however you may find our mocha generator for custom generators useful.

Debugging

To debug a generator, you can pass Node.js debug's flags by running it like this:

# OS X / Linux
node --debug `which yo` <generator> [arguments]

# Windows
node --debug <path to yo binary> <generator> [arguments]

Yeoman generators also use a debug mode to log relevant informations. You can activate it by setting the DEBUG environment variable to the desired scope (for the generator system scope is generators:*).

# OS X / Linux
DEBUG=generators/*

# Windows
set DEBUG=generators/*

Officially maintained generators

License

BSD license Copyright (c) Google

Something went wrong with that request. Please try again.