@petbee/tsconfig 1.0.4 → 3.0.0

package/README.md

@@ -1,21 +1,97 @@
 # `@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 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
+
 ## Usage
 
-### NestJS Project
+### React Project
+
+#### React Application 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:
 
+```json
+{
+  "extends": "@petbee/tsconfig/react/application.json",
+  "compilerOptions": {
+    "baseUrl": ".",
+    "rootDir": ".",
+    "paths": { "*": ["*", "app/*"] }
+  },
+  "include": ["./app/**/*", "./client/**/*", "./server/**/*", "./tests/**/*"]
+}
+```
+
+#### React Library Project
+
+Similarly for a react 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
+{
+  "extends": "@petbee/tsconfig/react/library.json",
+  "compilerOptions": {
+    "baseUrl": "./src",
+    "rootDir": "."
+  },
+  "include": ["./src/**/*"]
+}
+```
+
+#### Project that run in the browser
+
+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
+{
+  "extends": "@petbee/tsconfig/react/dom.json",
+  "compilerOptions": {
+    "baseUrl": ".",
+    "rootDir": "."
+  }
+}
+```
+
+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.
+
+**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
 {
   "extends": "@petbee/tsconfig/nestjs.json",
@@ -26,13 +102,61 @@ A typical setup where the application sit in `[project root]/app` folder is as f
 }
 ```
 
+### NodeJS 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.
+
+#### Node Application Project
+
+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:
+
+```json
+{
+  "extends": "@petbee/tsconfig/node/base.json",
+  "compilerOptions": {
+    "baseUrl": "./",
+    "outDir": "./dist"
+  }
+}
+```
+
+**For ESM projects**, ensure your `package.json` has:
+
+```json
+{
+  "type": "module"
+}
+```
+
+#### 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.
+
+```json
+{
+  "extends": "@petbee/tsconfig/node/library.json",
+  "compilerOptions": {
+    "baseUrl": "./src",
+    "rootDir": "."
+  },
+  "include": ["./src/**/*"]
+}
+```
+
 ### 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:
+
+- For Node.js ESM: use `node/base.json`
+- For CommonJS: use `nestjs.json` or override with `"moduleResolution": "node"`
+
 ```json
 {
-  "extends": "@petbee/tsconfig",
+  "extends": "@petbee/tsconfig/base.json",
   "compilerOptions": {
     "baseUrl": ".",
     "rootDir": "."
@@ -50,7 +174,7 @@ eg.
 
 ```json
 {
-  "extends": "@petbee/tsconfig",
+  "extends": "@petbee/tsconfig/base.json",
   "compilerOptions": {
     "baseUrl": ".",
     "rootDir": ".",

package/base.json

@@ -0,0 +1,27 @@
+{
+  "compileOnSave": false,
+  "compilerOptions": {
+    "target": "ES2022",
+    "lib": ["ES2023", "DOM"],
+    "module": "ESNext",
+    "moduleResolution": "bundler",
+    "esModuleInterop": true,
+    "isolatedModules": true,
+    "verbatimModuleSyntax": true,
+    "experimentalDecorators": true,
+    "noImplicitAny": true,
+    "noImplicitReturns": true,
+    "noImplicitThis": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    "noUncheckedIndexedAccess": true,
+    "allowUnusedLabels": false,
+    "allowUnreachableCode": false,
+    "resolveJsonModule": true,
+    "skipLibCheck": true,
+    "strict": true,
+    "strictFunctionTypes": true,
+    "strictNullChecks": true,
+    "forceConsistentCasingInFileNames": true
+  }
+}

package/nestjs.json

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

package/node/base.json

@@ -0,0 +1,22 @@
+{
+  "compileOnSave": false,
+  "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
+  }
+}

package/node/library.json

@@ -0,0 +1,9 @@
+{
+  "extends": "./base.json",
+  "compilerOptions": {
+    "declaration": true,
+    "declarationMap": true,
+    "noEmit": false,
+    "noEmitHelpers": true
+  }
+}

package/package.json

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

package/react/application.json

@@ -0,0 +1,6 @@
+{
+  "extends": "./dom.json",
+  "compilerOptions": {
+    "noEmit": true
+  }
+}

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

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

package/react/library.json

@@ -0,0 +1,9 @@
+{
+  "extends": "./dom.json",
+  "compilerOptions": {
+    "declaration": true,
+    "declarationMap": true,
+    "noEmit": false,
+    "noEmitHelpers": true
+  }
+}

package/tsconfig.json

@@ -1,26 +0,0 @@
-{
-  "compilerOptions": {
-    "alwaysStrict": true,
-    "allowSyntheticDefaultImports": true,
-    "esModuleInterop": true,
-    "jsx": "react",
-    "lib": ["es2017", "dom", "es2018.promise", "esnext.asynciterable", "es2019", "es2020", "esnext"],
-    "module": "esnext",
-    "moduleResolution": "node",
-    "noImplicitAny": true,
-    "noImplicitReturns": true,
-    "noImplicitThis": true,
-    "noUnusedLocals": true,
-    "noUnusedParameters": true,
-    "skipLibCheck": true,
-    "sourceMap": true,
-    "strictFunctionTypes": true,
-    "strictNullChecks": true,
-    "strictPropertyInitialization": true,
-    "target": "es2020",
-    "forceConsistentCasingInFileNames": true
-  },
-  "typeAcquisition": {
-    "enable": true
-  }
-}