generator-jolzee-node-module

⚙️ This generator generates a (universal) npm module boilerplate

What does module-boilerplate offer?

Project structure to create a cross build npm module
Linting: via ESLint
Testing: with Coverage via Jest
CommonJS: build (/dist/cjs) via Babel
ES2015: build (/dist/es) via Babel
UMD build: (/dist/umd) via Rollup (unminified & minified version)
Watch scripts: npm run (test|build):watch
Git hooks: precommit, prepush hooks defined in package.json
prepublish (before publishing to npm) script npm run build
Only publish what's needed (files field in package.json)

Nice to haves

README.md template 📝
... with npm, Travis, David, Gitmoji badges 📈
License generation
Travis CI integration 👷
Coverage Reporting via Coveralls
Typechecking: via Flow (optional)
webpro/release-it integration
Optimized for modern bundlers
unpkg ready 😎

+ Invisible contract which states that you will use gitmoji for commits 🤘 (just kidding, but you should)

You should probably enable greenkeeper (keeps your dependencies up to date)

Getting Started

Dependencies

install yeoman & this module globally via yarn

(this is one of the 'never install modules globally' exceptions)

yarn global add yo
yarn global add generator-jolzee-node-module

or via npm

npm install yo -g
npm install generator-jolzee-node-module -g

Running the generator

yo jolzee-node-module

Getting Started / Scripts

watch 👀

Testing via Jest in interactive watch mode

npm run test:watch

CommonJS build (/dist/cjs) via Babel

npm run build:watch

ℹ️ use a split terminal window for maximum developer experience

build ⚙️

npm run build

The build command runs the following steps:

Linting via ESLint (+ optional Flow typechecking)
Testing (with Coverage) via Jest
CommonJS build (/dist/cjs) via Babel
ES2015 build (/dist/es) via Babel
UMD builds (/dist) via Rollup

which equals to:

npm run lint
npm run test:coverage
npm run build:cjs
npm run build:es
npm run build:umd

testing ✅

Tests your src folder via Jest, (test env is included in .babelrc)

npm run test

or with coverage (also used in precommit / prepush / prepublish)

npm run test:coverage

releasing 🔖

ℹ️ more info on webpro/release-it
ℹ️ premajor = x.x.x-beta.x

⚠️ watch out, semver has different rules pre 1.0.0

npm run release (premajor|patch|minor|major)

Creates a version bump in package.json
Commits a change with this message '🔖 vX.X.X'
Creates a tag (github release) with the name 'vX.X.X' and as description 'Version X.X.X'
Push to remote (with tags)
npm publish (with npm run build as prepublish script)

⚠️ don't forget to answer Y on the 'publish to npm' question

You can change the release settings in the .release.json file in the root of your module folder.

Git Hooks ⛏

There are 2 git hooks defined in scripts in package.json
they check for broken builds and prevent push or commit.

prepush and precommit trigger:

Linting via ESLint (+ optional Flow typechecking)
Testing via Jest

License

The code is available under the MIT license.

jolzee/generator-jolzee-node-module