chore: add base type compilation setup

Author: voxpelli

.github/workflows/ci.yml

@@ -28,6 +28,26 @@ jobs:
       - name: ▶️ Run lint script
         run: npm run lint
 
+  types:
+    name: 🌋 Types
+    runs-on: ubuntu-latest
+    steps:
+      - name: ⬇️ Checkout repo
+        uses: actions/checkout@v4
+
+      - name: ⎔ Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: lts/*
+
+      - name: 📥 Install dependencies
+        run: npm ci
+
+      - name: ▶️ Typecheck
+        uses: gozala/[email protected]
+        with:
+          error_fail_threshold: 160
+
   test:
     name:
       🧪 Test (Node@${{ matrix.node }} - ESLint@${{ matrix.eslint }} - ${{

.gitignore

@@ -2,3 +2,9 @@ node_modules
 .idea
 coverage/
 .eslintcache
+
+# Generated types
+/rules/**/*.d.ts
+/rules/**/*.d.ts.map
+/index.d.ts
+/index.d.ts.map

declaration.tsconfig.json

@@ -0,0 +1,11 @@
+{
+  "$schema": "https://json.schemastore.org/tsconfig",
+  "extends": "./tsconfig",
+  "exclude": ["__tests__/**/*"],
+  "compilerOptions": {
+    "declaration": true,
+    "declarationMap": true,
+    "noEmit": false,
+    "emitDeclarationOnly": true
+  }
+}

package-lock.json

@@ -22,11 +22,20 @@
     "Aadit M Shah <[email protected]> (https://aadit.codes/)"
   ],
   "scripts": {
+    "build:0": "run-s clean",
+    "build:1-declaration": "tsc -p declaration.tsconfig.json",
+    "build": "run-s build:*",
+    "check": "run-s clean && run-p check:*",
+    "clean:declarations-lib": "rm -rf $(find rules -type f -name '*.d.ts*')",
+    "clean:declarations-top": "rm -rf $(find . -maxdepth 1 -type f -name '*.d.ts*')",
+    "clean": "run-p clean:*",
     "format": "prettier --write . && eslint . --fix",
-    "lint": "npm-run-all \"lint:*\"",
     "lint:eslint-docs": "npm run update:eslint-docs && git diff --exit-code",
     "lint:js": "eslint --report-unused-disable-directives .",
+    "skip:lint:tsc": "tsc",
+    "lint": "run-s clean && run-p lint:*",
     "prepare": "husky",
+    "skip:prepublishOnly": "run-s build",
     "test": "jest --coverage",
     "update:eslint-docs": "eslint-doc-generator && npm run format"
   },
@@ -66,6 +75,8 @@
     ]
   },
   "devDependencies": {
+    "@types/eslint": "^9.6.0",
+    "@types/node": "^18.19.42",
     "@typescript-eslint/parser": "^7.17.0",
     "doctoc": "^2.2.1",
     "eslint": "^8.56.0",
@@ -81,7 +92,7 @@
     "lint-staged": "^15.2.7",
     "npm-run-all2": "^6.2.2",
     "prettier": "^3.3.3",
-    "typescript": "~5.5.4"
+    "typescript": "~5.5.3"
   },
   "peerDependencies": {
     "eslint": "^7.0.0 || ^8.0.0 || ^9.0.0"

package.json

@@ -0,0 +1,46 @@
+{
+  "files": ["index.js"],
+  "include": ["rules/**/*", "__tests__/**/*"],
+  "compilerOptions": {
+    "lib": ["es2022"],
+    "target": "es2022",
+    "types": ["node"],
+
+    "module": "node16",
+    "moduleResolution": "node16",
+
+    "strict": true,
+
+    "skipLibCheck": false, // See https://github.com/voxpelli/tsconfig/issues/1
+
+    /* Clean up generated declarations */
+    "removeComments": false,
+    "stripInternal": true,
+
+    /* Make it a JS-targeted config */
+    "allowJs": true,
+    "checkJs": false, // Set to true to check all js files
+    "noEmit": true,
+    "resolveJsonModule": true,
+
+    /* Additional type checks */
+    "exactOptionalPropertyTypes": true,
+    "noFallthroughCasesInSwitch": true,
+    "noImplicitOverride": true,
+    "noPropertyAccessFromIndexSignature": true,
+    "noUncheckedIndexedAccess": true,
+
+    /* Additional non-type checks */
+    "forceConsistentCasingInFileNames": true,
+    "noImplicitReturns": false, // Deactivated as I believe implicit "return undefined" at end of function is okay + explicit clashes with ESLint "no-useless-return"
+    "noUnusedLocals": true,
+    "noUnusedParameters": true
+
+    /* To make strict checking somewhat less strict during a transition stage, add one or more of: */
+    /*
+    "noImplicitThis": false,
+    "noImplicitAny": false,
+    "strictNullChecks": false,
+    */
+  }
+}