update-yeoman-generator


> Update your Yeoman generator with style

[![MIT License][license-badge]][license]
[![PRs Welcome][prs-badge]][prs]
[![Watch on GitHub][github-watch-badge]][github-watch]
[![Star on GitHub][github-star-badge]][github-star]
[![Tweet][twitter-badge]][twitter]

A script to help update repositories using Yeoman generators to the latest version.

Requirements

To use this package the generator should:

- Creates a .yo-rc.json storing the version of your application. It should follow the Yeoman storage specs.

``json
// .yo-rc.json
{
"generator-poi": {
"version": "1.0.0"
}
}
`

Setup

$3

If you are using this project for private repositories, you'll need to create a token with the notifications and repo permissions. After generate your token, pass the information token using the flag --github-token in your command.

`bash
update-yeoman-generator --generator / --github-token
`

$3

Make sure you have npm@>=5.2.0:

`
npm install -g npm@latest
`

$3

- -g, --generator [required] Name of the Github generator. It should be in format
update-yeoman-generator --generator /
- --version [optional] Show package version number
- --ejs-open [optional] [default: "<%"] .ejs File delimiter for open tag
- --ejs-close [optional] [default: "%>"] .ejs File delimiter for close tag.
- -t, --template [optional] [default: "app/templates"] String with a prefix for your templates
folder based on the root folder of the generator repository.
- --github-token [optional] Github Token required for private repositories
- -h, --help [optional] Show help command

Inside the existing boilerplate generated repository run:

`
update-yeoman-generator
`

update-yeoman-generator will apply the changes from the latest version of boilerplate as a git style merge - so you'll still need to manually fix conflicts.

Usage

`bash
$ npm install -g update-yeoman-generator
$ cd
$ update-yeoman-generator --help
Options:
--version Show version number [boolean]
--github-token Optional: Github Token required for private repositories.
--ejs-open Optional: '.ejs' File delimiter for open tag. Default:
"app/templates"
--ejs-close Optional: '.ejs' File delimiter for close tag. Default:
"app/templates"
-h, --help Show help [boolean]
-g, --generator Name of the Github generator. It should be in format
/ [required]
-t, --template Optional: String with a prefix for your templates folder
based on the root folder of the generator repository.
Default: "app/templates"

EX:

update-yeoman-generator --generator
willmendesneto/generate-poi --template-prefix
app/templates

update-yeoman-generator --generator
/ --github-token
--template-prefix app/templates
[string]

Copyright 2017

$ update-yeoman-generator --generator /
``

Author

Wilson Mendes (willmendesneto)
+
+

[license-badge]: https://img.shields.io/badge/license-MIT%20License-blue.svg?style=flat-square
[license]: https://github.com/willmendesneto/nodebots-workshop/blob/master/LICENSE

[prs-badge]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square
[prs]: http://makeapullrequest.com

[github-watch-badge]: https://img.shields.io/github/watchers/willmendesneto/update-yeoman-generator.svg?style=social
[github-watch]: https://github.com/willmendesneto/update-yeoman-generator/watchers

[github-star-badge]: https://img.shields.io/github/stars/willmendesneto/update-yeoman-generator.svg?style=social
[github-star]: https://github.com/willmendesneto/update-yeoman-generator/stargazers

[twitter]: https://twitter.com/intent/tweet?text=Check%20out%20update-yeoman-generator%20by%20@willmendesneto%20https://goo.gl/sqZ8dh%20%F0%9F%91%8D
[twitter-badge]: https://img.shields.io/twitter/url/https/github.com/willmendesneto/update-yeoman-generator.svg?style=social