template-npm-package
This is a template for an npm package. It supports three output targets: CommonJS, EcmaScript module, and UMD.
Description of npm tasks:
| script | comments |
|---|---|
| start | runs webpack dev server with webpack.dev.js config |
| build | create CommonJS, ES module, and UMD builds |
| bundle | run Webpack to create a UMD bundle |
| clean | remove generated artifacts |
| format | run prettier on src directory |
| generateTypes | generate type declarations |
| lint | run eslint on src directory |
| transpileCommonJs | run babel on src directory; transpile import/export statements for a CommonJS compatible build |
| transpileES | run babel on src directory; do not transpile import/export statements for an ES module compatible build (used by bundlers for tree-shaking) |
| test | run mocha; searches for any files matching the pattern "src/**/*.test.js" |
| typeCheck | run tsc in type-check only mode |