Scaffold out a node module with ES6+, Babel, tape and npm scripts
Install
npm i -g generator-rise
☭ Features
- Babel ☝️
- Lint with ESLint
- Tests with tape in ES6
- Travis CI and Coveralls
- Productivity scripts and source watcher
- Check
package
dependencies - Automatic TOC with tocdoc
- Badges with
- Option to center title and badges in README.
- Simple workflow.
- Example
Usage
You need Yeoman to run this command.
yo rise
→ create package.json
→ create README.md
→ create LICENSE
→ create CHANGELOG.md
→ create src/index.js
→ create test/index.js
→ create .editorconfig
→ create .gitignore
→ create .travis.yml
→ create .eslintrc
🔰 Workflow
-
Add code to
src/index.js
and tests totest/index.js
. -
Lint, build and test a project with
npm run build
. -
Build and watch changes in
src/
withnpm run watch
-
Run only tests with
npm run test
. -
Check coverage with
npm run coverage
. -
Generate a TOC for the
CHANGELOG
withnpm run toc
-
Deploy to a remote origin with
npm run deploy
. -
Bump version and publish a package with
npm run major
orminor/patch
License
MIT © Jorge Bucaran