Split jsconfigs by environment

Author: andy0130tw

.github/workflows/ci.yml

@@ -11,7 +11,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node-version: [18.x, 20.x, 22.x]
+        node-version: [20.x, 22.x, 24.x]
 
     steps:
     - uses: actions/checkout@v4
@@ -30,6 +30,9 @@ jobs:
     - name: Run Svelte check
       run: npm run check
 
+    - name: Run tsc check
+      run: npm run tsc
+
     - name: Build
       run: npm run build
 

README.md

@@ -7,8 +7,8 @@ This template is derived from [the official template](https://github.com/sveltej
 Some notable customizations are:
 
 0. `package-lock.json` is NOT committed on purpose
-1. Vite 6.0 and Vitest 3.0 is included
-2. The included adapter is changed from `auto` to `@sveltejs/adapter-node`, assuming that you are not targeting [any specific deployment target](https://svelte.dev/docs/kit/adapter-auto).
+1. The included adapter is changed from `auto` to `@sveltejs/adapter-node`, assuming that you are not targeting [any specific deployment target](https://svelte.dev/docs/kit/adapter-auto).
+2. Split tsconfig of web/test/node environments via cascading `jsconfig.*.json` to avoid lib pollution.
 
 ## Instructions
 

jsconfig.app.json

@@ -0,0 +1,27 @@
+{
+  "extends": "./jsconfig.base.json",
+  "compilerOptions": {
+    "sourceMap": true,
+    "tsBuildInfoFile": "node_modules/.tmp/app.tsbuildinfo"
+  },
+  // Path aliases are handled by https://svelte.dev/docs/kit/configuration#alias
+  // except $lib which is handled by https://svelte.dev/docs/kit/configuration#files
+  //
+  // If you want to overwrite includes/excludes, make sure to copy over the relevant includes/excludes
+  // from the referenced tsconfig.json - TypeScript does not merge them in
+  "exclude": [
+    // copied from .svelte-kit/tsconfig.json
+    "./node_modules/**",
+    "./src/service-worker.js",
+    "./src/service-worker/**/*.js",
+    "./src/service-worker.ts",
+    "./src/service-worker/**/*.ts",
+    "./src/service-worker.d.ts",
+    "./src/service-worker/**/*.d.ts",
+    // exclude tests
+    "./src/**/*.spec.js",
+    "./src/**/*.spec.ts",
+    "./src/**/*.test.js",
+    "./src/**/*.test.ts"
+	]
+}

jsconfig.base.json

@@ -0,0 +1,15 @@
+{
+  "extends": "./.svelte-kit/tsconfig.json",
+  "compilerOptions": {
+    "allowJs": true,
+    "checkJs": true,
+    "esModuleInterop": true,
+    "forceConsistentCasingInFileNames": true,
+    "resolveJsonModule": true,
+    "skipLibCheck": true,
+    "sourceMap": false,
+    "strict": true,
+    "moduleResolution": "bundler",
+    "composite": true
+  }
+}

jsconfig.json

@@ -1,19 +1,12 @@
 {
   "extends": "./.svelte-kit/tsconfig.json",
-  "compilerOptions": {
-    "allowJs": true,
-    "checkJs": true,
-    "esModuleInterop": true,
-    "forceConsistentCasingInFileNames": true,
-    "resolveJsonModule": true,
-    "skipLibCheck": true,
-    "sourceMap": true,
-    "strict": true,
-    "moduleResolution": "bundler"
-  }
-  // Path aliases are handled by https://svelte.dev/docs/kit/configuration#alias
-  // except $lib which is handled by https://svelte.dev/docs/kit/configuration#files
-  //
-  // If you want to overwrite includes/excludes, make sure to copy over the relevant includes/excludes
-  // from the referenced tsconfig.json - TypeScript does not merge them in
+  "references": [
+    { "path": "./jsconfig.app.json" },
+    { "path": "./jsconfig.vitest.json" },
+    { "path": "./jsconfig.node.json" }
+  ],
+  // ensure it a dummy config
+  "include": [],
+  "exclude": [],
+  "files": []
 }

jsconfig.node.json

@@ -0,0 +1,10 @@
+{
+  "extends": "./jsconfig.base.json",
+  "compilerOptions": {
+    "tsBuildInfoFile": "node_modules/.tmp/node.tsbuildinfo",
+    "lib": ["esnext"]
+  },
+  "include": [
+    "./vite.config.js"
+  ]
+}

jsconfig.vitest.json

@@ -0,0 +1,12 @@
+{
+  "extends": "./jsconfig.base.json",
+  "compilerOptions": {
+    "tsBuildInfoFile": "node_modules/.tmp/vitest.tsbuildinfo"
+  },
+  "include": [
+    "./src/**/*.spec.js",
+    "./src/**/*.spec.ts",
+    "./src/**/*.test.js",
+    "./src/**/*.test.ts"
+  ]
+}

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@qbane/sveltekit-template",
-  "version": "0.0.4",
+  "version": "0.0.5",
   "description": "My opinionated SvelteKit template in pure JavaScript.",
   "author": "qbane",
   "type": "module",
@@ -9,22 +9,24 @@
     "dev": "vite dev",
     "build": "vite build",
     "preview": "vite preview",
-    "check": "svelte-kit sync && svelte-check --tsconfig ./jsconfig.json",
+    "check": "svelte-kit sync && svelte-check --tsconfig ./jsconfig.app.json",
+    "tsc": "tsc -b jsconfig.json",
     "check:watch": "svelte-kit sync && svelte-check --tsconfig ./jsconfig.json --watch",
     "test:unit": "vitest",
     "test": "npm run test:unit -- --run"
   },
   "devDependencies": {
     "@sveltejs/adapter-node": "^5.2.12",
-    "@sveltejs/kit": "^2.21.4",
+    "@sveltejs/kit": "^2.22.2",
     "@sveltejs/vite-plugin-svelte": "^5.1.0",
-    "svelte": "^5.34.1",
-    "svelte-check": "^4.2.1",
+    "@types/node": "^22.15.34",
+    "svelte": "^5.34.9",
+    "svelte-check": "^4.2.2",
     "typescript": "^5.8.3",
     "vite": "^6.3.5",
-    "vitest": "^3.2.3"
+    "vitest": "^3.2.4"
   },
   "engines": {
-    "node": ">=18.0.0 <23.0.0"
+    "node": ">=20.0.0 <25.0.0"
   }
 }