generator-node-mdl

Create a Node.js module with ease

See node-mdl-starter, it is an example of what you get using this generator and it is automatically generated with every new release of this generator.

Why

Generates a simple but ready to start project
Includes only necessary tools
Monitors repo quality through helpful badges
Supports ES2015+ using Babel 7
Jest testing framework
Sensible ESLint config extends standard and Prettier
Automates code reformatting using Prettier
Build your documentations using esdoc (optional)
Travis CI configuration (optional)
Coveralls configuration (optional)
Automatically deploy to npm registry with Travis CI (optional)
Automates versioning releases with semantic-release and commitizen (optional)
Friendly for contributions using Issue, Pull Request, and Contributing templates and some extras (optional)

Installation

npm install --global yo generator-node-mdl

Usage

yo node-mdl
# answer questions

With the most basic options, youʼll get a project structured like this:

$ tree
.
├── .github
│   ├── issue_template.md
│   └── pull_request_template.md
├── other
│   ├── code_of_conduct.md
│   ├── examples.md
│   └── roadmap.md
├── src
│   ├── index.js
│   └── index.test.js
├── .babelrc
├── .editorconfig
├── .esdoc.json
├── .eslintignore
├── .eslintrc
├── .gitattributes
├── .gitignore
├── .npmignore
├── .travis.yml
├── contributing.md
├── license
├── package.json
├── readme.md
└── yarn.lock

Less boilerplate 🎉

Options

There are 2 ways to supply your data to this generator. The obvious way is runnin yo node-mdl and answer all questions. You can bypass questions by passing options as arguments.

Run yo node-mdl --help to see the different options.

About passwords and tokens

This project contain some features that will make your life easier when setting up a new open-source project. Based on your choices, you may be asked to supply some of your accounts usernames and passwords (github, npm, etc...) so this project will automatically produce tokens for those accounts and save them to your TravisCI as secured enviorment variables if needed. You can bypass those questions by manually creating tokens and supply them using options as arguments.

--npmToken my-token is needed when using with --npmDeploy.

Your token will end up in TravisCI as a secured enviorment variables called NPM_TOKEN.

creating and viewing npm authentication tokens
--githubToken my-token is needed when using with --createGithubRepository or with --travisCI.

creating and viewing github authentication tokens
- When using with --createGithubRepository your token doesn't need to contain any scope.
- When using with --travisCI but without --semanticRelease your token doesn't need to contain any scope.
- When using with --travisCI and with --semanticRelease your token need to contain the following scopes:
  - repo
  - read:org
  - user:email
  - repo_deployment
  - repo:status
  - write:repo_hook

FAQ

How to upgrade existing project scaffolded with Yeoman?

Read how to do it here.

Forked from

generator-oss － Supports ES2015+ and XO by default

generator-bunny － Supports ES2015+ and Flow by default
generator-kcd-oss － Lots of features but many things left untouched
generator-nm － A way simpler Yeoman generator

License

MIT © Avi Sharvit

Contributing

Contributions are always welcome, no matter how large or small.

Working on your first Pull Request? You can learn how from this free series How to Contribute to an Open Source Project on GitHub

Code of Conduct

By participating, you are expected to uphold this Contributor Covenant Code of Conduct. Please report unacceptable behavior to sharvita@gmail.com.

Project setup

First, fork then clone the repo:

git clone https://github.com/your-username/generator-node-mdl
cd generator-node-mdl
git remote add upstream https://github.com/sharvit/generator-node-mdl

Install dependencies:

yarn

Run test suits to validate the project is working:

yarn test

Run linter to validate the project code:

yarn lint
# to fix linting errors
yarn lint --fix

Run linter to validate your commit message:

yarn lint:commit

Creating Pull Requests

Create a branch:

git checkout -b my-branch

Happy Hacking 🎉: Start hacking and creating code changes.
Commit your changes:

generator-node-mdl uses commitizen to create commit messages so semantic-release can automatically create releases.

git add .
yarn commit
# answer the questions

Push your changes:

git push origin my-branch

Open this project on GitHub, then click “Compare & pull request”.

Help needed

Please checkout the roadmap.md and the open issues.

Also, please watch the repo and respond to questions/bug reports/feature requests, Thanks!

Contributor Covenant Code of Conduct

Our Pledge

In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.

Our Standards

Examples of behavior that contributes to creating a positive environment include:

Using welcoming and inclusive language
Being respectful of differing viewpoints and experiences
Gracefully accepting constructive criticism
Focusing on what is best for the community
Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

The use of sexualized language or imagery and unwelcome sexual attention or advances
Trolling, insulting/derogatory comments, and personal or political attacks
Public or private harassment
Publishing others‘ private information, such as a physical or electronic address, without explicit permission
Other conduct which could reasonably be considered inappropriate in a professional setting

Our Responsibilities

Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.

Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.

Scope

This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.

Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at sharvita@gmail.com. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.

Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project‘s leadership.

Attribution

This Code of Conduct is adapted from the Contributor Covenant, version 1.4, available at http://contributor-covenant.org/version/1/4

Project Roadmap

This is where we‘ll define a few things about the library‘s goals.

We haven‘t filled this out yet though. Care to help? See contributing.md

Want to do

Might do

Give option to generate cli tools

Won‘t do

Won't do XO