Package Exports

yeoman-generator
yeoman-generator/lib/actions/invoke
yeoman-generator/lib/actions/string
yeoman-generator/lib/actions/user
yeoman-generator/lib/util/conflicter
yeoman-generator/lib/util/log
yeoman-generator/lib/util/storage

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 (yeoman-generator) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Generator

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/*

JSPM

yeoman-generator