@petbee/tsconfig 1.0.1 → 1.0.3

package/README.md

@@ -1,19 +1,60 @@
-# Petbee `tsconfig.json`
+# `@petbee/tsconfig`
 
 This is default `tsconfig.json` that should be used by all Petbee projects.
 
 ## Install
 
-Add a `tsconfig.json` file inside your builder folder (react or node) with the following
+```bash
+yarn add -D @petbee/tsconfig
+```
+
+## Usage
+
+### 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:
 
 ```json
 {
-  "extends": "@petbee/tsconfig"
+  "extends": "@petbee/tsconfig/nestjs.json",
+  "compilerOptions": {
+    "rootDir": "./src"
+  },
+  "exclude": ["node_modules", "dist", "tests/**/*", "**/*.spec.ts"]
 }
 ```
 
-And run
+### All Other Project
 
-```bash
-yarn add -D @petbee/tsconfig
+A base configuration file is also provided if the above does not fit your need.
+
+```json
+{
+  "extends": "@petbee/tsconfig",
+  "compilerOptions": {
+    "baseUrl": ".",
+    "rootDir": "."
+  }
+}
+```
+
+## Common Got Ya
+
+#### Type Checking does not honour `skipLibCheck: true` setting
+
+There are times when the type failure occur inside of a library your project is consuming, and having `skipLibCheck: true` does not resolved it. In this scenario, add an `exclude` option to your `tsconfig.json`.
+
+eg.
+
+```json
+{
+  "extends": "@petbee/tsconfig",
+  "compilerOptions": {
+    "baseUrl": ".",
+    "rootDir": ".",
+    "exclude": ["./node_modules/**/*"]
+  }
+}
 ```

package/nestjs.json

@@ -0,0 +1,17 @@
+{
+  "compilerOptions": {
+    "module": "commonjs",
+    "declaration": true,
+    "removeComments": true,
+    "emitDecoratorMetadata": true,
+    "experimentalDecorators": true,
+    "allowSyntheticDefaultImports": true,
+    "target": "ES2019",
+    "sourceMap": true,
+    "outDir": "./dist",
+    "baseUrl": "./",
+    "incremental": true,
+    "skipLibCheck": true,
+    "esModuleInterop": true
+  }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@petbee/tsconfig",
-  "version": "1.0.1",
+  "version": "1.0.3",
   "publishConfig": {
     "access": "public"
   },
@@ -15,5 +15,5 @@
   "peerDependencies": {
     "typescript": "^3 || ^4 || ^5"
   },
-  "gitHead": "9987c88805147a050ed1eca4413916241b5596da"
+  "gitHead": "4abb4d54bdc927736aee06803e0e9a5d179acfa1"
 }

package/tsconfig.json

@@ -4,8 +4,8 @@
     "allowSyntheticDefaultImports": true,
     "esModuleInterop": true,
     "jsx": "react",
-    "lib": ["es2017", "dom", "es2018.promise", "esnext.asynciterable"],
-    "module": "es6",
+    "lib": ["es2017", "dom", "es2018.promise", "esnext.asynciterable", "es2020", "esnext"],
+    "module": "esnext",
     "moduleResolution": "node",
     "noImplicitAny": true,
     "noImplicitReturns": true,
@@ -17,10 +17,10 @@
     "strictFunctionTypes": true,
     "strictNullChecks": true,
     "strictPropertyInitialization": true,
-    "target": "es2017",
+    "target": "esnext",
     "forceConsistentCasingInFileNames": true
   },
   "typeAcquisition": {
-    "enable": false
+    "enable": true
   }
 }