@petbee/tsconfig 1.0.3 → 2.0.0

package/README.md

@@ -10,6 +10,55 @@ yarn add -D @petbee/tsconfig
 
 ## Usage
 
+### 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 included styles setup and a more conservative build target.
+
+```json
+{
+  "extends": "@petbee/tsconfig/react/dom.json",
+  "compilerOptions": {
+    "baseUrl": ".",
+    "rootDir": "."
+  }
+}
+```
+
 ### NestJS Project
 
 To start, create a `tsconfig.json` in the root of your project.
@@ -26,13 +75,46 @@ A typical setup where the application sit in `[project root]/app` folder is as f
 }
 ```
 
+### NodeJS Project
+
+#### 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"
+  }
+}
+```
+
+#### 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.
 
 ```json
 {
-  "extends": "@petbee/tsconfig",
+  "extends": "@petbee/tsconfig/base.json",
   "compilerOptions": {
     "baseUrl": ".",
     "rootDir": "."
@@ -50,7 +132,7 @@ eg.
 
 ```json
 {
-  "extends": "@petbee/tsconfig",
+  "extends": "@petbee/tsconfig/base.json",
   "compilerOptions": {
     "baseUrl": ".",
     "rootDir": ".",

package/{tsconfig.json → base.json}

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

package/nestjs.json

@@ -6,7 +6,7 @@
     "emitDecoratorMetadata": true,
     "experimentalDecorators": true,
     "allowSyntheticDefaultImports": true,
-    "target": "ES2019",
+    "target": "es2020",
     "sourceMap": true,
     "outDir": "./dist",
     "baseUrl": "./",

package/node/base.json

@@ -0,0 +1,15 @@
+{
+  "compileOnSave": false,
+  "compilerOptions": {
+    "esModuleInterop": true,
+    "isolatedModules": true,
+    "experimentalDecorators": true,
+    "lib": ["es2020"],
+    "moduleResolution": "node",
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    "resolveJsonModule": true,
+    "skipLibCheck": true,
+    "strict": 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.3",
+  "version": "2.0.0",
   "publishConfig": {
     "access": "public"
   },
@@ -15,5 +15,5 @@
   "peerDependencies": {
     "typescript": "^3 || ^4 || ^5"
   },
-  "gitHead": "4abb4d54bdc927736aee06803e0e9a5d179acfa1"
+  "gitHead": "0885e6ebef089afcee9b87428cf90ecb8c95e946"
 }

package/react/application.json

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

package/react/dom.json

@@ -0,0 +1,10 @@
+{
+  "extends": "../base.json",
+  "compilerOptions": {
+    "jsx": "react",
+    "lib": ["dom", "dom.iterable", "scripthost", "es2020"],
+    "module": "esnext",
+    "target": "es2020"
+  },
+  "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
+  }
+}