/typescript-node-boilerplate

🧙🏼‍♂️ Typescript Node Boilerplate - Better, faster, stronger

Primary LanguageTypeScriptMIT LicenseMIT

Typescript Node Boilerplate

TypeScript version Node.js version Build Status - GitHub Actions

Quick and dirty typescript boilerplate for immediate developer productivity.

  • TypeScript 4.9
  • ESM
  • ESLint with some initial rules recommendation
  • Jest for fast unit testing and code coverage
  • Type definitions for Node.js and Jest
  • Prettier to enforce consistent code style
  • NPM scripts for common operations
  • EditorConfig for consistent coding style
  • Example configuration for GitHub Actions
  • Simple example of TypeScript code and unit test

Getting Started

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

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,
  • prettier - reformat files,
  • test - run tests,
  • test:watch - interactive watch mode to automatically re-run tests