Add type checking

Author: bblanchon

.github/workflows/build.yml

@@ -26,13 +26,16 @@ jobs:
       - name: Setup Node
         uses: actions/setup-node@v4
         with:
-          node-version: '20'
-          cache: 'npm'
+          node-version: "20"
+          cache: "npm"
 
       - run: npm install
       - name: Lint
         run: npm run lint
 
+      - name: Type check
+        run: npm run type-check
+
       - name: Setup Pages
         id: pages
         uses: actions/configure-pages@v5

env.d.ts

@@ -0,0 +1 @@
+/// <reference types="vite/client" />

package-lock.json

@@ -7,21 +7,27 @@
     "dev": "vite",
     "build": "vite build",
     "preview": "vite preview",
-    "lint": "markdownlint src/pages"
+    "lint": "markdownlint src/pages",
+    "type-check": "vue-tsc --build --force"
   },
   "devDependencies": {
     "@rollup/pluginutils": "^5.1.3",
+    "@tsconfig/node20": "^20.1.4",
     "@types/markdown-it": "^14.1.2",
+    "@types/markdown-it-attrs": "^4.1.3",
     "@types/node": "^22.9.1",
     "@vitejs/plugin-vue": "^5.2.0",
+    "@vue/tsconfig": "^0.6.0",
     "gray-matter": "^4.0.3",
     "markdown-it": "^14.1.0",
     "markdown-it-attrs": "^4.2.0",
     "markdown-it-highlightjs": "^4.2.0",
     "markdown-it-replace-link": "^1.2.1",
     "markdownlint-cli": "^0.42.0",
     "sass": "^1.81.0",
+    "typescript": "^5.6.3",
     "vite": "^5.4.11",
-    "vue": "^3.5.13"
+    "vue": "^3.5.13",
+    "vue-tsc": "^2.1.10"
   }
 }

package.json

@@ -1,9 +1,9 @@
 import { dataToEsm } from "@rollup/pluginutils"
-import { Plugin, Logger, ViteDevServer } from "vite"
+import type { Plugin, Logger, ViteDevServer } from "vite"
 
-import { Page } from "./pages"
+import type { Page } from "./pages"
 import { getErrors } from "./validation"
-import { PageLoader, LoaderConfig, PageFile } from "./loader"
+import { PageLoader, type LoaderConfig, type PageFile } from "./loader"
 
 type UserOptions = LoaderConfig
 
@@ -63,7 +63,7 @@ export default function TroubleshooterPlugin(
     if (file.options)
       page.options = file.options.map((option) => ({
         id: option.id,
-        page: files.findIndex((f) => (f.filename == option.page)),
+        page: files.findIndex((f) => f.filename == option.page),
         label: option.label,
         summary: option.summary
       }))