node-template

Installation

Prerequisites

Before going through the installation steps described in this template, make sure that you have the following installed on your local machine :

• nvm : to manage your Node.js environment
• yarn : to install the project's dependencies

Setup

Node

First, we install the latest stable Node.js version :

# Install the LTS version, see https://nodejs.org
nvm install --lts

# Freeze the version
node --version > .nvmrc

# For bash and zsh users
npx json -I -f package.json -e 'this.engines.node="'$(node --version)'"'
# For fish users
npx json -I -f package.json -e 'this.engines.node="'(node --version)'"'

Typescript

Then, we install Typescript :

# Install typescript
yarn add -D typescript @types/node

# Install tsc-watch to enable hot-reloading in development mode
yarn add -D tsc-watch

# Install rimraf
yarn add -D rimraf

You can now build and run the project using the following commands :

• yarn build : will transpile the typescript sources into javascript
• yarn start : will execute the generated javascript code
• yarn dev : starts the "dev mode", it watches the files and restarts on every change

At this point, we have a working typescript project. To improve the development experience, we will also configure a few more utilities.

Linter

We will use a combination of eslint and prettier :

# Install eslint with typescript support
yarn add -D eslint @typescript-eslint/parser @typescript-eslint/eslint-plugin

# Install prettier and plug it to eslint
yarn add -D prettier eslint-config-prettier eslint-plugin-prettier


# Install support for imports sorting
yarn add -D eslint-plugin-simple-import-sort

# Make all error warnings (can be useful in react build for example)
yarn add -D eslint-plugin-only-warn

# Optional: install support for jsdoc (optional)
yarn add -D eslint-plugin-jsdoc

You can now run the linter using the following commands :

• yarn test:lint : will run the linter and report every errors
• yarn test:lint --fix : will fix the errors that can be "auto-fixed"

Automated tests

We will use jest :

# Install jest with typescript support
yarn add -D jest @types/jest ts-jest

Once jest is installed, you can run the automated tests located in the test folder using the following commands :

• yarn test:jest : will run all the tests and generate a coverage report
• yarn jest <pattern> : will execute all of the test files matching the provided pattern

You can also run all of the tests (build + linter + automated tests) using the following command. It can be useful in your CI :

• yarn test

Enhanced source-map (optional)

Because we are transpiling our typescript into javascript and then executing the javascript code, we are loosing precious information in the Error stacktrace. In order to correct the stacktrace and have it reference the original typescript code, you can install the package source-map-support.

# Install source-map-support along with its typings
yarn add source-map-support
yarn add -D @types/source-map-support

Then, at the entry point of your project, add the following import.

// inside of src/main.ts
import 'source-map-support/register';