TypeScript template

Overview 📑

An opinionated TypeScript template repository that provides the following tooling:

Tool	Utility
ESLint	Code linter
Husky	Git hooks
Jest	Testing framework
Prettier	Code formatter
Yarn (berry)	Package manager

Prerequisites ✅

• Node.js (LTS)
  • Consider using nvm to manage your Node.js installations which uses the .nvmrc file to set the correct Node.js version
• Yarn
  • Consider managing Yarn with corepack -- it ships with Node.js v16+ and enabling Yarn is as simple as running:

    corepack enable
    

Getting started 🚀

Install dependencies:

yarn install

Scripts 💻️

Check if all project files meet the formatting standards:

yarn check-format

Check if all project files meet the linting standards:

yarn check-lint

Run all tests:

yarn test

Git hooks 🪝

Hook	Description
pre-commit	Uses lint-staged to lint and format the staged commit files before they are committed