feat(ci): add CI workflow for type checking and linting

Author: Prateet-Github

.github/workflows/ci.yml

@@ -0,0 +1,35 @@
+name: CI - Quality Check
+
+on:
+  push:
+    branches: [ main, master ]
+  pull_request:
+    branches: [ main, master ]
+
+jobs:
+  quality:
+    name: Type Check & Lint
+    runs-on: ubuntu-latest
+
+    # Set the working directory to 'api' since that's where package.json is
+    defaults:
+      run:
+        working-directory: ./api
+
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20'
+          cache: 'npm'
+          cache-dependency-path: api/package-lock.json
+
+      - name: Install Dependencies
+        run: npm ci
+
+      - name: Type Check
+        # This runs the TypeScript compiler just to check for errors, not to emit files
+        run: npx tsc --noEmit

api/nodemon.json

@@ -1,6 +1,6 @@
 {
   "watch": ["./"],
   "ext": "ts,json",
-  "ignore": ["dist"],
+  "ignore": ["dist", "node_modules"],
   "exec": "tsx server.ts"
 }

api/tsconfig.json

@@ -1,44 +1,25 @@
 {
-  // Visit https://aka.ms/tsconfig to read more about this file
   "compilerOptions": {
-    // File Layout
-    // "rootDir": "./src",
-    // "outDir": "./dist",
+    // 1. Change rootDir to current directory
+    "rootDir": "./",
+    "outDir": "./dist",
 
-    // Environment Settings
-    // See also https://aka.ms/tsconfig/module
+    // 2. Standard settings
     "module": "nodenext",
-    "target": "esnext",
-    "types": [],
-    // For nodejs:
-    // "lib": ["esnext"],
-    // "types": ["node"],
-    // and npm install -D @types/node
-
-    // Other Outputs
+    "moduleResolution": "nodenext",
+    "target": "es2022",
     "sourceMap": true,
     "declaration": true,
-    "declarationMap": true,
-
-    // Stricter Typechecking Options
+    "strict": true,
     "noUncheckedIndexedAccess": true,
     "exactOptionalPropertyTypes": true,
-
-    // Style Options
-    // "noImplicitReturns": true,
-    // "noImplicitOverride": true,
-    // "noUnusedLocals": true,
-    // "noUnusedParameters": true,
-    // "noFallthroughCasesInSwitch": true,
-    // "noPropertyAccessFromIndexSignature": true,
-
-    // Recommended Options
-    "strict": true,
-    "jsx": "react-jsx",
+    "skipLibCheck": true,
     "verbatimModuleSyntax": true,
     "isolatedModules": true,
-    "noUncheckedSideEffectImports": true,
-    "moduleDetection": "force",
-    "skipLibCheck": true,
-  }
-}
+    "moduleDetection": "force"
+  },
+  // 3. Include all TS files in this folder and subfolders
+  "include": ["**/*.ts"],
+  // 4. CRITICAL: Ignore node_modules and the build output
+  "exclude": ["node_modules", "dist"]
+}