readme.md

🇨🇭 generator-swiss

The Swiss Army Knife of Yeoman generators

Features

• npm module generator - yo swiss
• Changelog generator with Keep a Changelog format - yo swiss:changelog
• GitHub's recommended files for Open Source repositories - yo swiss:github
• Minimal Readme generator - yo swiss:readme
• Shell script generator following Google's Shell Style Guide - yo swiss:sh

This is what I use for my own modules and repositories.

Install

npm install --global yo generator-swiss

Usage

With yo:

yo swiss

There are multiple command-line options available:

$ 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

yo --generators

Available Generators:

  swiss
    changelog
    github
    minimal-readme
    sh

Related projects

• minimal-readme - Clean readme template.

License

MIT © rodrigobdz