README
init
A more complete npm init
🧭 Table of contents
✨ Benefits
- Builds on
npm init - Differentiates between browser and NodeJS-only packages
- Sets up docs generator, unit & mutation testing, minification, etc.
🎒 Requierments
To use this package you will need:
🚀 Quickstart
Install
npm install -g @danielcobo/init
Note: In case you're wondering, @danielcobo/ is just a namespace scope - an NPM feature. Scopes make it easier to name modules and improve security.
Example use
In the terminal run:
init
Follow the prompts to set up the package.
That's it. Go build something amazing 😄.
🆘 Troubleshooting
If you run into trouble or have questions just submit an issue.
🤝 Contributing
Anyone can contribute
Contributions come in many shapes and sizes. All are welcome. You can contribute by:
- asking questions
- suggesting features
- sharing this repo with friends
- improving documentation (even fixing typos counts 😉)
- providing tutorials (if you do, please let me know, I would love to read them)
- improving tests
- contributing code (new features, performance boosts, code readability improvements..)
Rules for contributions
General guidelines:
- there are no dumb questions
- be polite and respectful to others
- do good
When coding remember:
- working > maintainability > performance
- best code is no code
- be descriptive when naming
- keep it DRY
- do test
Contribution licence: All contributions are considered to be under same license as this repository.
🧪 Testing
Testing suite: 🃏 Jest | Test command: npm test
Mutation testing suite: 👽 Stryker Mutator | Mutation test command: npm run mutation
If you intend to develop further or contribute code, then please ensure to write and use testing. Strive for 100% code coverage and high mutation scores. Mutation score 100 is great, but it's not always neccessary (if there are valid reasons).