@total-typescript/tsconfig

Install the package as a development dependency to use its pre-configured TypeScript configurations in your project.

npm install --save-dev @total-typescript/tsconfig

To use a configuration, identify your project type and add the corresponding extends property to your tsconfig.json.

Decision Logic

1. Are you using tsc to transpile .ts to .js?

   • If Yes: Use the /tsc/ path prefix.
   • If No (e.g., using Vite, Remix, Astro, Nuxt): Use the /bundler/ path prefix.

2. Does your code run in the DOM?

   • If Yes: Use the /dom/ segment.
   • If No (e.g., Node.js): Use the /no-dom/ segment.

3. What is the project structure?

   • App: Use /app.
   • Library: Use /library.
   • Library in a Monorepo: Use /library-monorepo.

// Example: Building an app that runs in the DOM with an external bundler
{
  "extends": "@total-typescript/tsconfig/bundler/dom/app"
}

The base configurations do not cover certain specific options. You can override or add these in your local tsconfig.json under compilerOptions.

• jsx: Set this if your app uses JSX (e.g., "jsx": "react-jsx").
• outDir: Set this if you are using tsc and want to specify the output directory for compiled files.

// Configuring JSX
{
  "extends": "@total-typescript/tsconfig/bundler/dom/app",
  "compilerOptions": {
    "jsx": "react-jsx"
  }
}

// Configuring outDir for tsc
{
  "extends": "@total-typescript/tsconfig/tsc/no-dom/library",
  "compilerOptions": {
    "outDir": "dist"
  }
}