Minimalistic boilerplate to jump-start a Node.js project in TypeScript 2.0.
Provides a basic template, batteries included:
- TypeScript to ES6 transpilation,
- TSLint with a general recommendation for a good default configuration,
- Jest unit testing and coverage,
- Type definitions for Node.js and Jest,
- NPM scripts for common operations,
- .editorconfig for consistent file format.
This project requires Node.js 6.2+ and 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
Writing unit tests in TypeScript can sometimes be troublesome and confusing. Especially when mocking dependencies and using spies.
This is optional, but if you want to learn how to write JavaScript tests for TypeScript modules, read the corresponding wiki page.
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.
MIT License. See the LICENSE file.