NPM Module Boilerplate

[!type=dev)

Mailoop Javascript Toolbox ✨

Javascript toolbox from Mailoop Tech Team

Happy hacking =)

Contribute

• ES6/ESNext - Write ES6 code and Babel will transpile it to ES5 for backwards compatibility
• Test - Mocha with Istanbul coverage
• Lint - Preconfigured ESlint with Airbnb config
• CI - TravisCI configuration setup
• Minify - Built code will be minified for performance

Commands

• yarn run clean - Remove lib/ directory
• yarn test - Run tests with linting and coverage results.
• yarn test:only - Run tests without linting or coverage.
• yarn test:watch - You can even re-run tests on file changes!
• yarn test:prod - Run tests with minified code.
• yarn run test:examples - Test written examples on pure JS for better understanding module usage.
• yarn run lint - Run ESlint with airbnb-config
• yarn run cover - Get coverage report for your code.
• yarn run build - Babel will transpile ES6 => ES5 and minify the code.
• yarn run prepublish - Hook for npm. Do all the checks before publishing your module.

Installation

License

MIT © Mailoop Tech Team