Table of Contents

• Table of Contents
• 📄 Goal
• 💡 What you will find?
• ✨ Features
• ❓ How to install and use it?
• 📚 Examples of usage
  • React project

📄 Goal

This configuration package provides common TypeScript configurations that can be used across different project types. It aims to standardize TypeScript settings across your projects while reducing the boilerplate configuration needed for each new project.

💡 What you will find?

This package includes TypeScript configurations for:

• react.json: Configuration optimized for React projects
• node.json: Configuration optimized for Node.js projects

✨ Features

• 🔍 Type Safety - Strict type checking for better code quality
• 🎯 Project-Specific Configs - Tailored for different environments
• 🚀 Easy Integration - Simple setup with minimal configuration
• 🔄 Consistent Settings - Standardized TypeScript settings across projects
• 🛠️ Best Practices - Incorporates TypeScript community best practices

❓ How to install and use it?

To install and use this package, follow these steps:

1. Install the package using your package manager:

   pnpm add -D @tutods/typescript-config typescript

   

   yarn add -D @tutods/typescript-config typescript

   

   npm install -D @tutods/typescript-config typescript

2. Create a tsconfig.json file in your project root and extend the configuration

📚 Examples of usage

React project

{
  "extends": "@tutods/typescript-config/react.json",
  "compilerOptions": {
    "baseUrl": ".",
    "paths": {
      "@/*": ["./src/*"]
    }
  },
  "include": ["src"]
}