Starter kit for NPM packages.
Overall, this starter kit provides the standard boilerplate constructs to develop and build a NPM package. It has some configurable project settings with included *rc/*ignore files for:
- TypeScript (tsconfig.base.json for the latest TypeScript features)
- Git (.gitignore, pretty much the standard Node.js one provided by Github)
- NPM (.npmignore, pretty much the .gitignore above with a few small changes)
Also, it provides an extensible build process integrated with npm scripts. The following is a breakdown of npm scripts provided and how to use them:
npm run dev
- to run two nodemon processes automatically based on watched files, one to rebuild application code and the other to run tests.npm run fix
- to automatically apply JS Standard Style to all JS code.npm run lint
- to run JS Standard Style checks.npm run release
- to test and build production code.npm test
- to run unit tests.npm version
- to run production test and build, git commit version update, and publish.npm run tsc
- to build production output.