tsconfig-react

Shared TypeScript configuration for React projects using TypeScript.

Installation

To use this configuration in your project, install the necessary dependencies:

npm install --save-dev @uvarovag/tsconfig-react typescript ts-node

Usage

Step 1: Create a tsconfig.json file

{
    "extends": "@uvarovag/tsconfig-react",
    // Files and folders to be included in the compilation process
    "include": [
        "src", // Only files in the "src" folder
        "global.d.ts" // Includes global type definitions
    ],
    // Files and folders to be excluded from the compilation process
    "exclude": [
        "node_modules", // Ignores the "node_modules" folder
        "dist" // Ignores the "dist" folder (compiled code)
    ],
    "compilerOptions": {
        // Specifies the folder where the compiled code will be output
        "outDir": "./dist/",
        // Sets the base path for all relative paths
        "baseUrl": "./",
        // Configures path aliases for convenient module imports
        "paths": {
            "*": ["./src/*"] // All imports start from "src"
        }
    }
}

Step 2: Create a global.d.ts file

declare const IS_DEV: boolean
declare const BASE_URL: string

Step 3: Compile your project

npx tsc