Rails-inspired generator system that provides scaffolding for your apps — yeoman.io

readme.md

Generator Build Status Coverage Status

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.

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 lifecycle informations. You can activate it by setting the DEBUG environment variable to the desired scope (the scope of the generator system is yeoman:generator).

# OS X / Linux
DEBUG=yeoman:generator

# Windows
set DEBUG=yeoman:generator

License

BSD license Copyright © Google