An opinionated boilerplate project built with Node.js and Typescript.
The following npm scripts can be run using npm run <script>
. This project relies on cross-env
and rimraf
utilities in order to support cross-platform opening and deleting files.
build
- build the TypeScript files and output to lib/
clean
- recursively delete the lib/
and coverage/
directoriesclean:build
- recursively delete the lib/
directoryclean:coverage
- recursively delete the coverage/
directorycoverage
- run the test suite and generate code coverage reportscoverage:open
- run npm run coverage then open the results in a browserdev
- concurrently run build:watch
and start:watch
lint
- run the linter configured by TSLint on the src/
directorystart
- run serverstart:dev
- run server from src
start:watch
- relaunch the server if new changes are detected in src/
test
- run unit tests defined in the tests/
directorytest:watch
- run tests in watch modetest:ci
- run unit tests and generate necessary files for CI integration