node-typescript-boilerplate

[![Sponsor][sponsor-badge]][sponsor] [][typescript-4-3] [![Node.js version][nodejs-badge]][nodejs] [![APLv2][license-badge]][license] [![Build Status - GitHub Actions][gha-badge]][gha-ci]

👩🏻‍💻 Developer Ready: A comprehensive template. Works out of the box for most [Node.js][nodejs] projects.

🏃🏽 Instant Value: All basic tools included and configured:

• [TypeScript][typescript] [4.3][typescript-4-3]
• [ESLint][eslint] with some initial rules recommendation
• [Jest][jest] for fast unit testing and code coverage
• Type definitions for Node.js and Jest
• [Prettier][prettier] to enforce consistent code style
• NPM scripts for common operations
• Simple example of TypeScript code and unit test
• .editorconfig for consistent file format
• Reproducible environments thanks to [Volta][volta]
• Example configuration for [GitHub Actions][gh-actions]

🤲 Free as in speech: available under the APLv2 license.

Getting Started

This project is intended to be used with the latest Active LTS release of [Node.js][nodejs].

Use as a repository template

To start, just click the [Use template][repo-template-action] link (or the green button). Start adding your code in the src and unit tests in the __tests__ directories.

Clone repository

To clone the repository, use the following commands:

git clone https://github.com/jsynowiec/node-typescript-boilerplate
cd node-typescript-boilerplate
npm install

Download latest release

Download and unzip the current main branch or one of the tags:

wget https://github.com/jsynowiec/node-typescript-boilerplate/archive/main.zip -O node-typescript-boilerplate.zip
unzip node-typescript-boilerplate.zip && rm node-typescript-boilerplate.zip

Available Scripts

• clean - remove coverage data, Jest cache and transpiled files,
• prebuild - lint source files and tests before building,
• build - transpile TypeScript to ES6,
• build: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

Additional Informations

Why include Volta

[Volta][volta]’s toolchain always keeps track of where you are, it makes sure the tools you use always respect the settings of the project you’re working on. This means you don’t have to worry about changing the state of your installed software when switching between projects. For example, it's [used by engineers at LinkedIn][volta-tomdale] to standardize tools and have reproducible development environments.

I recommend to [install][volta-getting-started] Volta and use it to manage your project's toolchain.

Writing 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][wiki-js-tests].

Backers & Sponsors

Support this project by becoming a [sponsor][sponsor].

License

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

[nodejs-badge]: https://img.shields.io/badge/Node.js->=%2014.16-blue.svg [nodejs]: https://nodejs.org/dist/latest-v14.x/docs/api/ [gha-badge]: https://github.com/jsynowiec/node-typescript-boilerplate/actions/workflows/nodejs.yml/badge.svg [gha-ci]: https://github.com/jsynowiec/node-typescript-boilerplate/actions/workflows/nodejs.yml [typescript]: https://www.typescriptlang.org/ [typescript-4-3]: https://www.typescriptlang.org/docs/handbook/release-notes/typescript-4-3.html [license-badge]: https://img.shields.io/badge/license-APLv2-blue.svg [license]: https://github.com/jsynowiec/node-typescript-boilerplate/blob/main/LICENSE [sponsor-badge]: https://img.shields.io/badge/♥-Sponsor-fc0fb5.svg [sponsor]: https://github.com/sponsors/jsynowiec [jest]: https://facebook.github.io/jest/ [eslint]: https://github.com/eslint/eslint [wiki-js-tests]: https://github.com/jsynowiec/node-typescript-boilerplate/wiki/Unit-tests-in-plain-JavaScript [prettier]: https://prettier.io [volta]: https://volta.sh [volta-getting-started]: https://docs.volta.sh/guide/getting-started [volta-tomdale]: https://twitter.com/tomdale/status/1162017336699838467?s=20 [gh-actions]: https://github.com/features/actions [repo-template-action]: https://github.com/jsynowiec/node-typescript-boilerplate/generate