@petbee/tsconfig 2.0.0 → 3.0.1

package/README.md

@@ -1,32 +1,53 @@
 # `@petbee/tsconfig`
 
-This is default `tsconfig.json` that should be used by all Petbee projects.
+This is the default `tsconfig.json` that should be used by all Petbee projects.
+
+## Features (v3.0.0)
+
+- ✅ **TypeScript 5.9+** - Modern TypeScript support
+- ✅ **ES2022+ Target** - Modern JavaScript features
+- ✅ **Modern Module Resolution** - `bundler` for web apps, `NodeNext` for Node.js
+- ✅ **Strict Type Safety** - Including `noUncheckedIndexedAccess` for safer array access
+- ✅ **Verbatim Module Syntax** - Better ESM compatibility
+- ✅ **React 17+ JSX** - New JSX transform (`react-jsx`)
 
 ## Install
 
 ```bash
-yarn add -D @petbee/tsconfig
+yarn add -D @petbee/tsconfig typescript
 ```
 
+## Module Resolution Guide
+
+
+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/**/*"]
 }
 ```
 
@@ -47,7 +68,9 @@ Similarly for a react library project. Create a `tsconfig.json` in the root of y
 
 #### Project that run in the browser
 
-A configuration file is provided that included styles setup and a more conservative build target.
+A configuration file is provided that includes styles setup and modern React JSX transform.
+
+**Note:** This config uses `"jsx": "react-jsx"` (the new JSX transform from React 17+), which means you don't need to import React in every file that uses JSX.
 
 ```json
 {
@@ -59,11 +82,18 @@ A configuration file is provided that included styles setup and a more conservat
 }
 ```
 
+The React DOM config includes type definitions for:
+
+- Image imports (`.svg`, `.png`, `.jpg`, etc.)
+- Style imports (`.css`, `.scss`, `.module.css`, etc.)
+
 ### NestJS Project
 
 To start, create a `tsconfig.json` in the root of your project.
 
-A typical setup where the application sit in `[project root]/app` folder is as follow:
+**Note:** The NestJS config uses CommonJS module system (`"module": "commonjs"`) and Node.js module resolution, which is optimal for NestJS applications.
+
+A typical setup where the application sit in `[project root]/src` folder is as follow:
 
 ```json
 {
@@ -77,15 +107,16 @@ A typical setup where the application sit in `[project root]/app` folder is as f
 
 ### NodeJS Project
 
-#### Node Application Project
+**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.
 
-To start, create a `tsconfig.json` in the root of your project.
 
-A typical setup where the application sit in `[project root]/src` folder is as follow:
+#### Node.js Project (ESM)
+
+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"
@@ -93,24 +124,33 @@ A typical setup where the application sit in `[project root]/src` folder is as f
 }
 ```
 
-#### Node Library Project
+**For ESM projects**, ensure your `package.json` has:
 
-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.
+```json
+{
+  "type": "module"
+}
+```
+
+
+#### 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.
+### Custom/Advanced Usage
+
+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
 {
@@ -122,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/base.json

@@ -1,16 +1,22 @@
 {
   "compileOnSave": false,
   "compilerOptions": {
+    "target": "ES2022",
+    "lib": ["ES2023", "DOM"],
+    "module": "ESNext",
+    "moduleResolution": "bundler",
     "esModuleInterop": true,
     "isolatedModules": true,
+    "verbatimModuleSyntax": true,
     "experimentalDecorators": true,
-    "lib": ["dom", "es2020"],
-    "moduleResolution": "node",
     "noImplicitAny": true,
     "noImplicitReturns": true,
     "noImplicitThis": true,
     "noUnusedLocals": true,
     "noUnusedParameters": true,
+    "noUncheckedIndexedAccess": true,
+    "allowUnusedLabels": false,
+    "allowUnreachableCode": false,
     "resolveJsonModule": true,
     "skipLibCheck": true,
     "strict": true,

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,17 +1,3 @@
 {
-  "compilerOptions": {
-    "module": "commonjs",
-    "declaration": true,
-    "removeComments": true,
-    "emitDecoratorMetadata": true,
-    "experimentalDecorators": true,
-    "allowSyntheticDefaultImports": true,
-    "target": "es2020",
-    "sourceMap": true,
-    "outDir": "./dist",
-    "baseUrl": "./",
-    "incremental": true,
-    "skipLibCheck": true,
-    "esModuleInterop": 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,15 +1,9 @@
 {
-  "compileOnSave": false,
+  "extends": "../../base.json",
   "compilerOptions": {
-    "esModuleInterop": true,
-    "isolatedModules": true,
-    "experimentalDecorators": true,
-    "lib": ["es2020"],
-    "moduleResolution": "node",
-    "noUnusedLocals": true,
-    "noUnusedParameters": true,
-    "resolveJsonModule": true,
-    "skipLibCheck": true,
-    "strict": true
+    "target": "ES2022",
+    "lib": ["ES2023"],
+    "module": "NodeNext",
+    "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": "2.0.0",
+  "version": "3.0.1",
   "publishConfig": {
     "access": "public"
   },
@@ -15,5 +15,5 @@
   "peerDependencies": {
     "typescript": "^3 || ^4 || ^5"
   },
-  "gitHead": "0885e6ebef089afcee9b87428cf90ecb8c95e946"
+  "gitHead": "691cd678231d15a665a7bb1751cac4c2fa3789b1"
 }

package/react/definitions/images.d.ts

@@ -0,0 +1,39 @@
+declare module '*.svg' {
+  const content: string
+  export default content
+}
+
+declare module '*.png' {
+  const content: string
+  export default content
+}
+
+declare module '*.jpg' {
+  const content: string
+  export default content
+}
+
+declare module '*.jpeg' {
+  const content: string
+  export default content
+}
+
+declare module '*.gif' {
+  const content: string
+  export default content
+}
+
+declare module '*.webp' {
+  const content: string
+  export default content
+}
+
+declare module '*.ico' {
+  const content: string
+  export default content
+}
+
+declare module '*.bmp' {
+  const content: string
+  export default content
+}

package/react/definitions/styles.d.ts

@@ -0,0 +1,39 @@
+declare module '*.css' {
+  const content: { [className: string]: string }
+  export default content
+}
+
+declare module '*.scss' {
+  const content: { [className: string]: string }
+  export default content
+}
+
+declare module '*.sass' {
+  const content: { [className: string]: string }
+  export default content
+}
+
+declare module '*.less' {
+  const content: { [className: string]: string }
+  export default content
+}
+
+declare module '*.module.css' {
+  const content: { [className: string]: string }
+  export default content
+}
+
+declare module '*.module.scss' {
+  const content: { [className: string]: string }
+  export default content
+}
+
+declare module '*.module.sass' {
+  const content: { [className: string]: string }
+  export default content
+}
+
+declare module '*.module.less' {
+  const content: { [className: string]: string }
+  export default content
+}

package/react/dom.json

@@ -1,10 +1,10 @@
 {
-  "extends": "../base.json",
+  "extends": "../../base.json",
   "compilerOptions": {
-    "jsx": "react",
-    "lib": ["dom", "dom.iterable", "scripthost", "es2020"],
-    "module": "esnext",
-    "target": "es2020"
+    "jsx": "react-jsx",
+    "lib": ["ES2023", "DOM", "DOM.Iterable"],
+    "module": "ESNext",
+    "target": "ES2022"
   },
   "files": ["./definitions/images.d.ts", "./definitions/styles.d.ts"]
 }

package/react.json

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