README.md

node-typescript-boilerplate

Minimalistic boilerplate to jump-start a Node.js project in TypeScript 2.4.

Provides a basic template, "batteries included":

• TypeScript 2.4 to ES6 transpilation,
• TSLint 5.x with Microsoft recommended rules,
• Jest unit testing and code coverage,
• Type definitions for Node.js v6.x (LTS) and Jest,
• NPM scripts for common operations,
• a simple example of TypeScript code and unit test,
• .editorconfig for consistent file format.

Quick start

This project is intended to be used with latest LTS release of Node.js or later 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

or just download and unzip current master branch:

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

Unit tests in JavaScript

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.

Available scripts

• 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

Alternative

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.

License

MIT License. See the LICENSE file.