run-yo

Run a yeoman generator which you are developing, very quickly.

Usage no npm install needed!

<script type="module">
  import runYo from 'https://cdn.skypack.dev/run-yo';
</script>

README

run-yo

NPM version Travis-CI Status Appveyor Status Daviddm Status

Run a yeoman generator which you are developing, very quickly.

capture

To speed up a development on your yeoman generator!
Put a generated example into the generator repository easily. E.g. pandawing/generator-nm5/example
run-yo supports scoped module, like @sanemat/generator-nm.
run-yo based on yeomania.
For OS X, Linux And Windows.

Outline

  1. Create a directory in the system temporary directory.
  2. Create a symbolic link from src(working directory) to dest(temp/node_modules/your_generator).
  3. Execute Yo [your yeoman generator] in the temporary directory.
  4. Unlink the symbolic link.
  5. Move the app which is generated to the target.

Install

$ npm install --save run-yo

CLI

$ npm install --global run-yo
$ run-yo --help

  Usage
    run-yo [input (default: example)]

  Examples
    run-yo
    (run the yeoman generator from ./ to ./example/ )

    run-yo ../path/to/sample
    (run the yeoman generator from ./ to ../path/to/sample/ )

  Options
    --stable  RunYo safely, but slowly.           Default: false
    --info    Show a log above log level info.    Default: true
    --verbose Show a log above log level verbose. Default: false
    --debug   Show a log above log level debug.   Default: false

API

beta(input, [options])

CLI Default

Create a directory in the system temporary directory, npm install from working directory symbolic link from the generator, execute yo [current generator] and move to the target directory.

input

Required

Type: string

Run to the target directory.

options

info

Type: boolean

Default: true

Show a log above log level info.

verbose

Type: boolean

Default: false

Show a log above log level verbose.

debug

Type: boolean

Default: false

Show a log above log level debug.

stable(input, [options])

Create a directory in the system temporary directory, npm install from working directory, execute yo [current generator] and move to the target directory.

input

Required

Type: string

Run to the target directory.

options

info

Type: boolean

Default: true

Show a log above log level info.

verbose

Type: boolean

Default: false

Show a log above log level verbose.

debug

Type: boolean

Default: false

Show a log above log level debug.

Changelog

changelog.md.

License

MIT © sanemat