Meesayen / generator-rise

升 Scaffold out a node module with ES6+, Babel, Ava and npm scripts

Scaffold out a node module with ES6+, Babel, Ava and npm scripts

Install

npm i -g generator-rise

升 Features

• Babel
• Lint with ESLint
• Tests with Ava in ES6
• Travis CI and Coveralls with nyc code coverage
• Productivity scripts and source watcher
• Check package dependencies
• Automatic TOC with tocdoc
• Badges with
• Option to center title and badges in README.
• Simple workflow.

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.test.js
→ create .babelrc
→ create .editorconfig
→ create .gitignore
→ create .travis.yml
→ create .eslintrc
→ create .eslintignore

Workflow

• Add code to src/index.js and tests to test/index.test.js.

• Lint, build and test a project with npm run build.

• Build and watch changes in src/ with npm run watch

• Run only tests with npm run test.

• Check coverage with npm run coverage.

• Generate a TOC for the CHANGELOG with npm run toc

• Deploy to a remote origin with npm run deploy.

• Bump version and publish a package with npm run major or minor/patch

License

MIT © Jorge Bucaran (Enhanced by Federico Giovagnoli)