infra: improve tsconfigs

.eslintrc.js

@@ -21,7 +21,7 @@ module.exports = defineConfig({
   ],
   parser: '@typescript-eslint/parser',
   parserOptions: {
-    project: ['./tsconfig.lint.json'],
+    project: ['./tsconfig.json'],
     sourceType: 'module',
     warnOnUnsupportedTypeScriptVersion: false,
   },

.github/workflows/ci.yml

@@ -169,10 +169,10 @@ jobs:
       - name: Check formatting
         run: pnpm prettier --check .
 
-  ts-check-scripts:
+  ts-check:
     runs-on: ubuntu-latest
     timeout-minutes: 10
-    name: 'TS-Check Scripts: node-18, ubuntu-latest'
+    name: 'TS-Check: node-18, ubuntu-latest'
     steps:
       - name: Checkout
         uses: actions/checkout@v3
@@ -181,37 +181,6 @@ jobs:
 
       - name: Install pnpm
         uses: pnpm/action-setup@v2.2.4
-        with:
-          version: 7
-
-      - name: Set node version to 18
-        uses: actions/setup-node@v3
-        with:
-          node-version: 18
-          cache: 'pnpm'
-
-      - name: Install deps
-        run: pnpm install
-        env:
-          CYPRESS_INSTALL_BINARY: 0
-
-      - name: Check scripts
-        run: pnpm run ts-check:scripts
-
-  ts-check-tests:
-    runs-on: ubuntu-latest
-    timeout-minutes: 10
-    name: 'TS-Check Tests: node-18, ubuntu-latest'
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v3
-        with:
-          fetch-depth: 0
-
-      - name: Install pnpm
-        uses: pnpm/action-setup@v2.2.4
-        with:
-          version: 7
 
       - name: Set node version to 18
         uses: actions/setup-node@v3
@@ -224,8 +193,8 @@ jobs:
         env:
           CYPRESS_INSTALL_BINARY: 0
 
-      - name: Check tests
-        run: pnpm run ts-check:tests
+      - name: Check TS
+        run: pnpm run ts-check
 
   codecov:
     runs-on: ubuntu-latest

CONTRIBUTING.md

@@ -7,6 +7,8 @@ If you want to make `Faker` a better, please read the following contribution gui
 Please make sure that you run `pnpm run preflight` before making a PR to ensure that everything is working from the start.  
 This is a shorthand for running the following scripts in order:
 
+<!-- TODO @Shinigami92 2023-04-28: update below -->
+
 - `pnpm install` - installs npm packages defined in package.json
 - `pnpm run generate:locales` - generates locale files
 - `pnpm run generate:api-doc` - generates API documentation

package.json

@@ -53,16 +53,14 @@
   },
   "files": [
     "CHANGELOG.md",
-    "CHANGELOG_old.md",
     "dist",
-    "locale",
-    "tsconfig.json"
+    "locale"
   ],
   "scripts": {
     "clean": "rimraf coverage .eslintcache dist docs/.vitepress/dist pnpm-lock.yaml node_modules",
     "build:clean": "rimraf dist",
     "build:code": "tsx ./scripts/bundle.ts",
-    "build:types": "tsc --emitDeclarationOnly --outDir dist/types",
+    "build:types": "tsc --project tsconfig.build.json",
     "build": "run-s build:clean build:code build:types",
     "generate": "run-s generate:locales generate:api-docs",
     "generate:api-docs": "tsx ./scripts/apidoc.ts",
@@ -77,9 +75,7 @@
     "docs:diff": "tsx ./scripts/diff.ts",
     "format": "prettier --cache --write .",
     "lint": "eslint --cache --cache-strategy content --report-unused-disable-directives .",
-    "ts-check": "run-s ts-check:scripts ts-check:tests",
-    "ts-check:scripts": "tsc --project tsconfig.check-scripts.json",
-    "ts-check:tests": "tsc --project tsconfig.check-tests.json",
+    "ts-check": "tsc",
     "test": "vitest",
     "test:update-snapshots": "vitest run -u",
     "coverage": "vitest run --coverage",

test/scripts/apidoc/utils.ts

@@ -34,7 +34,6 @@ export function loadExampleMethods(): Record<string, SignatureReflection> {
   return loadProjectModules(
     {
       entryPoints: ['test/scripts/apidoc/signature.example.ts'],
-      tsconfig: 'test/scripts/apidoc/tsconfig.json',
     },
     true
   )['SignatureTest'][1];
@@ -47,7 +46,6 @@ export function loadExampleModules(): Record<string, DeclarationReflection> {
   const modules = loadProjectModules(
     {
       entryPoints: ['test/scripts/apidoc/module.example.ts'],
-      tsconfig: 'test/scripts/apidoc/tsconfig.json',
     },
     true
   );

tsconfig.build.json

@@ -0,0 +1,17 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "target": "ES2019",
+    "noEmit": false,
+    "emitDeclarationOnly": true,
+    "rootDir": "src",
+    "outDir": "dist/types",
+
+    // This negates what is set in the extended tsconfig.json
+    "noImplicitAny": true,
+    "skipLibCheck": false,
+    "allowSyntheticDefaultImports": false,
+    "resolveJsonModule": false
+  },
+  "include": ["src"]
+}

tsconfig.json

@@ -1,20 +1,22 @@
 {
   "compilerOptions": {
-    "target": "ES2019",
-    "moduleResolution": "Node",
-    "rootDir": "src",
-    "outDir": "dist",
+    "target": "ESNext",
+    "moduleResolution": "node",
+    "module": "ESNext",
+    "strict": true,
+    "noEmit": true,
     "declaration": true,
-    "esModuleInterop": true,
-    "allowJs": true,
-    "alwaysStrict": true,
-    "strictFunctionTypes": true,
-    "noImplicitAny": true,
-    "noImplicitThis": true,
-    "useUnknownInCatchVariables": true,
     "stripInternal": true,
-    "baseUrl": "."
+
+    // We need to disable these for now, and need to tackle them in another PR
+    "strictNullChecks": false,
+    "strictBindCallApply": false,
+    "noImplicitAny": false,
+
+    // These are configs specifically for !build and have to be reverted in the tsconfig.build.json
+    "skipLibCheck": true,
+    "allowSyntheticDefaultImports": true,
+    "resolveJsonModule": true
   },
-  "include": ["src/**/*"],
-  "exclude": ["node_modules"]
+  "exclude": ["node_modules", "dist", "locale"]
 }