@dizmo/generator-module
Generator for Node.js JavaScript, TypeScript and CoffeeScript modules
Generates NPM compatible module projects that can be published, installed and even upgraded. The supported development steps are cleaning, linting, building (including bundling) and testing (including coverage statistics).
Prerequisites
-
Node.js v14.15.3 LTS (or higher); for Linux distribution based packages (
deb
orrpm
) see also binary distributions.
Installation
npm install -g yo
npm install -g @dizmo/generator-module
Help
yo @dizmo/module --help
Generation
yo @dizmo/module [--git] [--typescript|--coffeescript]
Upgrade
yo @dizmo/module --upgrade
Development
Clean
npm run clean
Build
npm run build
without linting and cleaning:
npm run -- build --no-lint --no-clean
with UMD bundling (incl. minimization):
npm run -- build --prepack
with UMD bundling (excl. minimization):
npm run -- build --prepack --no-minify
Lint
npm run lint
with auto-fixing:
npm run -- lint --fix
Test
npm run test
without linting, cleaning and (re-)building:
npm run -- test --no-lint --no-clean --no-build
Cover
npm run cover
without linting, cleaning and (re-)building:
npm run -- cover --no-lint --no-clean --no-build
Documentation
npm run docs
Publication
npm publish
public
):
initially (if npm publish --access=public
Copyright
© dizmo AG, Switzerland