https://github.com/rodrigobdz/generator-swiss
🇨ðŸ‡The Swiss Army Knife of Yeoman generators
https://github.com/rodrigobdz/generator-swiss
auto-update generator-lnm generator-nm keep-a-changelog linted npm-module scaffold-template shellcheck update-notifier yeoman-generator
Last synced: 3 months ago
JSON representation
🇨ðŸ‡The Swiss Army Knife of Yeoman generators
- Host: GitHub
- URL: https://github.com/rodrigobdz/generator-swiss
- Owner: rodrigobdz
- License: mit
- Created: 2019-06-09T07:21:08.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2019-06-30T07:05:53.000Z (almost 6 years ago)
- Last Synced: 2025-03-06T10:12:06.133Z (4 months ago)
- Topics: auto-update, generator-lnm, generator-nm, keep-a-changelog, linted, npm-module, scaffold-template, shellcheck, update-notifier, yeoman-generator
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/generator-swiss
- Size: 139 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- Changelog: changelog.md
- Contributing: contributing.md
- License: license
- Code of conduct: code_of_conduct.md
Awesome Lists containing this project
README
# :switzerland: generator-swiss [](https://travis-ci.com/rodrigobdz/generator-swiss)
> The Swiss Army Knife of Yeoman generators
### Features
- npm module generator - `yo swiss`
- Changelog generator with [Keep a Changelog](https://keepachangelog.com/en/1.0.0) format - `yo swiss:changelog`
- [GitHub's recommended files](https://github.com/rodrigobdz/generator-swiss/community) for Open Source repositories - `yo swiss:github`
- [Minimal Readme](https://github.com/rodrigobdz/minimal-readme) generator - `yo swiss:readme`
- Shell script generator following [Google's Shell Style Guide](https://google.github.io/styleguide/shell.xml) - `yo swiss:sh`
This is what I use for [my own modules](https://www.npmjs.com/~rodrigobdz) and [repositories](https://github.com/rodrigobdz?tab=repositories).
## Install
```sh
npm install --global yo generator-swiss
```
## Usage
With [yo](https://github.com/yeoman/yo):
```sh
yo swiss
```
There are multiple command-line options available:
```sh
$ yo swiss --help
Usage:
yo swiss:app [options]
Options:
-h, --help # Print the generator's options and usage
--skip-cache # Do not remember prompt answers Default: false
--skip-install # Do not automatically install dependencies Default: false
--force-install # Fail on install dependencies error Default: false
--cli # Add a CLI
--coverage # Add code coverage with nyc
--codecov # Upload coverage to codecov.io (implies coverage)
```
### Generators
```sh
yo --generators
Available Generators:
swiss
changelog
github
minimal-readme
sh
```
## Related projects
- [minimal-readme](https://github.com/rodrigobdz/minimal-readme) - Clean readme template.
## License
[MIT](license) © [rodrigobdz](https://rodrigobdz.github.io)