generator-gemod

Scaffold out a node module

Generate files with sane defaults to reduce boilerplate

Install

$ yarn global add yo generator-gemod

Usage

With yo:

$ yo gemod

There are multiple command-line options available:

$ yo gemod --help

  Usage:
    yo gemod [options]

  Options:
    --help          # Print the generator's options and usage
    --org           # Publish to a GitHub organization account
    --skip-cache    # Do not remember prompt answers                      Default: false
    --skip-install  # Do not automatically install dependencies           Default: false
    --coverage      # Add jest's code coverage (uploads to codecov.io)    Default: false
    --deploy        # Adds a step to travis to deploy the module to npm   Default: false
		    # (needs `$NPM_TOKEN` env variable on travis-ci)

Development tools

• Test things with jest
• Lint code with xo and prettier
• Run linting before a git commit
• Run tests before a git push

Structure

The generated files will look like this:

├── .git
├── .gitignore
├── .npmrc
├── .prettierrc
├── .travis.yml
├── .travis.yml
├── .yo-rc.json
├── node_modules
├── index.js
├── index.test.js
├── license
├── package.json
├── readme.md
└── yarn.lock

Contributing

1. Fork it (https://github.com/George-Aidonidis/generator-gemod/fork)
2. Create your feature branch (git checkout -b feature/fooBar)
3. Commit your changes (git commit -am 'Add some fooBar')
4. Push to the branch (git push origin feature/fooBar)
5. Create a new Pull Request

License

MIT ©