@petbee/tsconfig 3.0.0 → 3.0.2

package/README.md

@@ -19,32 +19,35 @@ yarn add -D @petbee/tsconfig typescript
 
 ## Module Resolution Guide
 
-This package provides different configs optimized for different project types:
 
-- **`base.json`** - For bundled web apps (Vite, Webpack) - Uses `"moduleResolution": "bundler"`
-- **`node/base.json`** - For Node.js ESM projects - Uses `"moduleResolution": "NodeNext"`
-- **`nestjs.json`** - For NestJS projects - Uses `"moduleResolution": "node"` (CommonJS)
-- **`react/*`** - For React projects - Uses modern JSX transform
+This package provides entry-point configs for each framework, making it easy to extend the right config for your project:
+
+- **`base.json`** – Safe, strict defaults for all projects (modern web, library, etc.)
+- **`react.json`** – For React projects (extends `react/dom.json`)
+- **`node.json`** – For Node.js ESM projects (extends `node/base.json`)
+- **`nestjs.json`** – For NestJS projects (extends `nestjs/base.json`)
+- **`nextjs.json`** – For Next.js projects (extends `nextjs/base.json`)
+- **`node/commonjs.json`** – For legacy Node.js CommonJS projects
+
+You can also extend the more granular configs in each framework folder if you need a specific variant (e.g., `react/library.json`, `node/library.json`).
 
 ## Usage
 
 ### React Project
 
-#### React Application Project
 
-To start, create a `tsconfig.json` in the root of your project.
+#### React Project
 
-A typical setup where the application sit in `[project root]/app` folder is as follow:
+To start, create a `tsconfig.json` in the root of your project:
 
 ```json
 {
-  "extends": "@petbee/tsconfig/react/application.json",
+  "extends": "@petbee/tsconfig/react.json",
   "compilerOptions": {
     "baseUrl": ".",
-    "rootDir": ".",
-    "paths": { "*": ["*", "app/*"] }
+    "rootDir": "."
   },
-  "include": ["./app/**/*", "./client/**/*", "./server/**/*", "./tests/**/*"]
+  "include": ["./src/**/*"]
 }
 ```
 
@@ -106,15 +109,14 @@ A typical setup where the application sit in `[project root]/src` folder is as f
 
 **Note:** The Node.js config uses modern ESM module resolution (`"moduleResolution": "NodeNext"`). This is optimal for Node.js 18+ with native ESM support. If you're using CommonJS, consider using the NestJS config instead.
 
-#### Node Application Project
 
-To start, create a `tsconfig.json` in the root of your project.
+#### Node.js Project (ESM)
 
-A typical setup where the application sit in `[project root]/src` folder is as follow:
+To start, create a `tsconfig.json` in the root of your project:
 
 ```json
 {
-  "extends": "@petbee/tsconfig/node/base.json",
+  "extends": "@petbee/tsconfig/node.json",
   "compilerOptions": {
     "baseUrl": "./",
     "outDir": "./dist"
@@ -130,29 +132,25 @@ A typical setup where the application sit in `[project root]/src` folder is as f
 }
 ```
 
-#### Node Library Project
 
-Similarly for a node library project. Create a `tsconfig.json` in the root of your project with a setup below assuming the library code sit in `[project root]/src` folder.
+#### Node.js Project (CommonJS)
+
+For legacy Node.js projects using CommonJS, extend the CommonJS config:
 
 ```json
 {
-  "extends": "@petbee/tsconfig/node/library.json",
+  "extends": "@petbee/tsconfig/node/commonjs.json",
   "compilerOptions": {
-    "baseUrl": "./src",
-    "rootDir": "."
-  },
-  "include": ["./src/**/*"]
+    "baseUrl": "./",
+    "outDir": "./dist"
+  }
 }
 ```
 
-### All Other Project
-
-A base configuration file is also provided if the above does not fit your need.
 
-**Note:** The base config uses `"moduleResolution": "bundler"`, which is optimal for projects using modern bundlers (Vite, Webpack 5+, esbuild, etc.). If you need different module resolution:
+### Custom/Advanced Usage
 
-- For Node.js ESM: use `node/base.json`
-- For CommonJS: use `nestjs.json` or override with `"moduleResolution": "node"`
+If you need more control, you can extend any of the granular configs in the framework folders (e.g., `react/library.json`, `node/library.json`, etc.) or the base config directly:
 
 ```json
 {
@@ -164,6 +162,23 @@ A base configuration file is also provided if the above does not fit your need.
 }
 ```
 
+### TypeScript Configuration Notes
+
+#### Plugins
+
+- If you override the `plugins` array in your project’s tsconfig.json, **always include** the Next.js plugin for Next.js projects:
+  ```json
+  "plugins": [
+    { "name": "next" }
+  ]
+  ```
+- Omitting the Next.js plugin may cause type-checking and IDE features to break.
+
+#### Include/Exclude
+
+- If you set your own `include` or `exclude` arrays, they will completely replace those from the base config.
+- Use the recommended patterns from the base config unless you have a specific need.
+
 ## Common Got Ya
 
 #### Type Checking does not honour `skipLibCheck: true` setting

package/nestjs/base.json

@@ -0,0 +1,18 @@
+{
+  "extends": "../base.json",
+  "compilerOptions": {
+    "module": "commonjs",
+    "moduleResolution": "node",
+    "declaration": true,
+    "removeComments": true,
+    "emitDecoratorMetadata": true,
+    "experimentalDecorators": true,
+    "allowSyntheticDefaultImports": true,
+    "sourceMap": true,
+    "outDir": "./dist",
+    "baseUrl": "./",
+    "incremental": true,
+    "strictPropertyInitialization": false
+  },
+  "exclude": ["node_modules", "dist"]
+}

package/nestjs/build.json

@@ -0,0 +1,9 @@
+{
+  "extends": "./base.json",
+  "exclude": ["node_modules", "dist", "test", "**/*spec.ts", "dangerfile.ts", "prisma"],
+  "compilerOptions": {
+    "strictNullChecks": true,
+    "incremental": false,
+    "composite": false
+  }
+}

package/nestjs/eslint.json

@@ -0,0 +1,7 @@
+{
+  "extends": "./base.json",
+  "exclude": ["node_modules", "dist", "test", "**/*spec.ts", "@generated", "prisma"],
+  "compilerOptions": {
+    "strictNullChecks": true
+  }
+}

package/nestjs.json

@@ -1,21 +1,3 @@
 {
-  "compilerOptions": {
-    "target": "ES2022",
-    "lib": ["ES2023"],
-    "module": "commonjs",
-    "moduleResolution": "node",
-    "declaration": true,
-    "removeComments": true,
-    "emitDecoratorMetadata": true,
-    "experimentalDecorators": true,
-    "allowSyntheticDefaultImports": true,
-    "sourceMap": true,
-    "outDir": "./dist",
-    "baseUrl": "./",
-    "incremental": true,
-    "skipLibCheck": true,
-    "esModuleInterop": true,
-    "forceConsistentCasingInFileNames": true,
-    "strict": true
-  }
+  "extends": "./nestjs/base.json"
 }

package/nextjs/base.json

@@ -0,0 +1,24 @@
+{
+  "extends": "../base.json",
+  "compilerOptions": {
+    "target": "ES2020",
+    "lib": ["ES2020", "DOM", "DOM.Iterable"],
+    "plugins": [
+      {
+        "name": "next"
+      }
+    ],
+    "jsx": "preserve",
+    "allowJs": true,
+    "noEmit": true,
+    "incremental": true,
+    "removeComments": false,
+    "importHelpers": true,
+    "downlevelIteration": true,
+    "skipDefaultLibCheck": true,
+    "useDefineForClassFields": true,
+    "verbatimModuleSyntax": false,
+    "experimentalDecorators": false,
+    "emitDecoratorMetadata": false
+  }
+}

package/nextjs.json

@@ -0,0 +1,3 @@
+{
+  "extends": "./nextjs/base.json"
+}

package/node/base.json

@@ -1,22 +1,9 @@
 {
-  "compileOnSave": false,
+  "extends": "../base.json",
   "compilerOptions": {
     "target": "ES2022",
     "lib": ["ES2023"],
     "module": "NodeNext",
-    "moduleResolution": "NodeNext",
-    "esModuleInterop": true,
-    "isolatedModules": true,
-    "verbatimModuleSyntax": true,
-    "experimentalDecorators": true,
-    "noUnusedLocals": true,
-    "noUnusedParameters": true,
-    "noUncheckedIndexedAccess": true,
-    "allowUnusedLabels": false,
-    "allowUnreachableCode": false,
-    "resolveJsonModule": true,
-    "skipLibCheck": true,
-    "strict": true,
-    "forceConsistentCasingInFileNames": true
+    "moduleResolution": "NodeNext"
   }
 }

package/node/commonjs.json

@@ -0,0 +1,7 @@
+{
+  "extends": "./base.json",
+  "compilerOptions": {
+    "module": "CommonJS",
+    "moduleResolution": "node"
+  }
+}

package/node.json

@@ -0,0 +1,3 @@
+{
+  "extends": "./node/base.json"
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@petbee/tsconfig",
-  "version": "3.0.0",
+  "version": "3.0.2",
   "publishConfig": {
     "access": "public"
   },
@@ -15,5 +15,5 @@
   "peerDependencies": {
     "typescript": "^3 || ^4 || ^5"
   },
-  "gitHead": "e78d31f90c9546fa3b7e1959902bc6d703956349"
+  "gitHead": "abe6270b98022de98e790e3c06e568d5334845e1"
 }

package/react.json

@@ -0,0 +1,3 @@
+{
+  "extends": "./react/dom.json"
+}