TypeScript Template

A modern, opinionated TypeScript project template with integrated code quality tools and Git workflow automation.

Features

• ⚡ TypeScript configuration optimized for Node.js
• 🎨 Automated code formatting with Prettier
• 🔍 Code quality enforcement with ESLint
• 🪝 Git hooks for automated quality checks
• 📝 Standardized commit message templates

Quick Start

1. Install dependencies:

npm clean-install

2. Configure commit template:

git config commit.template .gitmessage

That's it! The installation automatically sets up Git hooks through the prepare script.

Commit Guidelines

• We follow conventional commits with emoji support
• Reference our commit template
• See Gitmoji Guide for emoji usage
• Read How to Write Better Commits

License

Update the LICENSE file before use. Choose a license:

• Popular Open Source Licenses
• OSI Approved Licenses

Project Setup Details

🔍 Understanding the Template Build Process

Base Setup

npm init
npm install --save-dev typescript @types/node
npx tsc --init

Code Quality Tools

npm install --save-dev \
    eslint \
    @eslint/js \
    @types/eslint__js \
    typescript-eslint \
    prettier \
    eslint-config-prettier \
    @types/eslint-config-prettier

Git Hooks Setup

npm install --save-dev husky lint-staged
npx husky-init && npm install

Key Configuration Files

• tsconfig.json: TypeScript configuration
• eslint.config.mjs: ESLint rules
• .prettierrc.mjs: Prettier settings
• .lintstagedrc.mjs: Pre-commit check configuration
• .husky/pre-commit: Git hook scripts

Additional Resources

• TypeScript Documentation
• Husky Documentation
• lint-staged Documentation
• Git Hooks Guide