- TypeScript 3.0,
- TSLint 5 with Microsoft rules,
- Jest unit testing and code coverage,
- Type definitions for Node.js v8 and Jest,
- Prettier to enforces a consistent code style (but it's optional),
- NPM scripts for common operations,
- a simple example of TypeScript code and unit test,
- .editorconfig for consistent file format.
This project is intended to be used with v8 (LTS Carbon) release of Node.js or newer and [NPM][npm]. Make sure you have those installed. Then just type following commands:
git clone https://github.com/jsynowiec/node-typescript-boilerplate cd node-typescript-boilerplate npm install
or just download and unzip current
wget https://github.com/jsynowiec/node-typescript-boilerplate/archive/master.zip -O node-typescript-boilerplate unzip node-typescript-boilerplate.zip && rm node-typescript-boilerplate.zip
Now start adding your code in the
src and unit tests in the
__tests__ directories. Have fun and build amazing things
Writing unit tests in TypeScript can sometimes be troublesome and confusing. Especially when mocking dependencies and using spies.
clean- remove coverage data, Jest cache and transpiled files,
build- transpile TypeScript to ES6,
watch- interactive watch mode to automatically transpile source files,
lint- lint source files and tests,
test- run tests,
test:watch- interactive watch mode to automatically re-run tests
As an alternative to TypeScript, you can try my Node.js Flow boilerplate. It's basically the same but with ES6, async/await, Flow type checking and ESLint.
Licensed under the APLv2. See the LICENSE file for details.