lab02-node-typescript-boilerplate v0.1.1

lab02-node-typescript-boilerplate

This code was created for learning purpose.

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

Provides a basic template, "batteries included":

• TypeScript 2.5 to ES6 transpilation,
• TSLint 5.x with Microsoft recommended rules,
• Jest unit testing and code coverage,
• Type definitions for Node.js v6.11.4 (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 v6.11.4 (LTS) release of Node.js or newer and NPM. Make sure you have those installed. Then just type following commands:

npm install --save lab02-node-typescript-boilerplate

Now start adding your code in the src and unit tests in the __tests__ directories.

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

Credits

This code is based on https://github.com/jsynowiec/node-typescript-boilerplate Many thank's to jsynowiec.

License

Licensed under the APLv2. See the LICENSE file for details.