TS configuration for docs package

Author: skirtles-code

src/template/vitepress/config/packages/docs/env.d.ts

@@ -0,0 +1,2 @@
+/// <reference types="vite/client" />
+/// <reference path="../@projectName@/src/global.d.ts" />

src/template/vitepress/config/packages/docs/package.json

@@ -3,16 +3,21 @@
   "scripts": {
     "clean": "rimraf dist && rimraf .vitepress/cache",
     "dev": "vitepress dev .",
-    "build": "vitepress build .",
+    "type-check": "vue-tsc --noEmit -p tsconfig.app.json --composite false",
+    "build": "pnpm run type-check && vitepress build .",
     "preview": "vitepress preview .",
     "preinstall": "node ../../scripts/preinstall.js"
   },
   "dependencies": {
     "vue": "^3.5.13"
   },
   "devDependencies": {
+    "@tsconfig/node22": "^22.0.0",
     "@types/node": "^22.13.0",
+    "@vue/tsconfig": "^0.7.0",
     "rimraf": "^6.0.1",
-    "vitepress": "^1.6.3"
+    "typescript": "~5.7.3",
+    "vitepress": "^1.6.3",
+    "vue-tsc": "^2.2.0"
   }
 }

src/template/vitepress/config/packages/docs/tsconfig.app.json

@@ -0,0 +1,13 @@
+{
+  "extends": "@vue/tsconfig/tsconfig.dom.json",
+  "include": ["env.d.ts", "src/**/*", "src/**/*.vue", "src/**/*.md"],
+  "compilerOptions": {
+    "tsBuildInfoFile": "../../node_modules/.tmp/tsconfig.docs.app.tsbuildinfo",
+    "paths": {
+      "@scopedPackageName@": ["../@projectName@/src/index.ts"]
+    }
+  },
+  "vueCompilerOptions": {
+    "vitePressExtensions": [".md"],
+  }
+}

src/template/vitepress/config/packages/docs/tsconfig.json

@@ -0,0 +1,11 @@
+{
+  "files": [],
+  "references": [
+    {
+      "path": "./tsconfig.node.json"
+    },
+    {
+      "path": "./tsconfig.app.json"
+    }
+  ]
+}

src/template/vitepress/config/packages/docs/tsconfig.node.json

@@ -0,0 +1,18 @@
+{
+  "extends": "@tsconfig/node22/tsconfig.json",
+  "include": [
+    "vite.config.*",
+    "vitest.config.*",
+    "cypress.config.*",
+    "nightwatch.conf.*",
+    "playwright.config.*",
+    "eslint.config.*"
+  ],
+  "compilerOptions": {
+    "noEmit": true,
+    "tsBuildInfoFile": "../../node_modules/.tmp/tsconfig.docs.node.tsbuildinfo",
+    "module": "ESNext",
+    "moduleResolution": "Bundler",
+    "types": ["node"]
+  }
+}

src/template/vitepress/examples/packages/docs/src/introduction.md

@@ -1,4 +1,4 @@
-<script setup>
+<script setup lang="ts">
 import { Example as ExampleComponent, MyPanel } from '@skirtle/test-project'
 </script>