chore: up ts and docs

vuejs · Nov 25, 2024 · c73e83f · c73e83f
1 parent 84dd1a1
commit c73e83f
Show file tree

Hide file tree

Showing 8 changed files with 703 additions and 471 deletions.
diff --git a/package.json b/package.json
@@ -42,9 +42,9 @@
     "p-series": "^3.0.0",
     "prettier": "^2.8.8",
     "semver": "^7.6.3",
-    "typedoc": "^0.25.13",
-    "typedoc-plugin-markdown": "^3.17.1",
-    "typescript": "~5.3.3",
+    "typedoc": "^0.26.11",
+    "typedoc-plugin-markdown": "^4.2.10",
+    "typescript": "~5.6.3",
     "vitest": "^2.1.5",
     "yorkie": "^2.0.0"
   },

diff --git a/packages/docs/package.json b/packages/docs/package.json
@@ -14,7 +14,7 @@
   },
   "dependencies": {
     "simple-git": "^3.27.0",
-    "vitepress": "1.2.3",
+    "vitepress": "1.5.0",
     "vitepress-translation-helper": "^0.2.1",
     "vue-router": "workspace:*"
   }

diff --git a/packages/docs/run-typedoc.mjs b/packages/docs/run-typedoc.mjs
@@ -6,10 +6,9 @@ const __dirname = path.dirname(new URL(import.meta.url).pathname)
 createTypeDocApp({
   name: 'API Documentation',
   tsconfig: path.resolve(__dirname, './typedoc.tsconfig.json'),
-  // entryPointStrategy: 'packages',
   categorizeByGroup: true,
   githubPages: false,
-  disableSources: true,
+  disableSources: true, // some links are in node_modules and it's ugly
   plugin: ['typedoc-plugin-markdown'],
   entryPoints: [path.resolve(__dirname, '../router/src/index.ts')],
 }).then(app => app.build())
diff --git a/packages/docs/typedoc-markdown.mjs b/packages/docs/typedoc-markdown.mjs
@@ -1,7 +1,7 @@
 // @ts-check
 import fs from 'node:fs/promises'
 import path from 'node:path'
-import { Application, TSConfigReader, PageEvent } from 'typedoc'
+import { Application, PageEvent, TSConfigReader } from 'typedoc'
 
 const __dirname = path.dirname(new URL(import.meta.url).pathname)
 
@@ -11,9 +11,8 @@ const DEFAULT_OPTIONS = {
   excludeInternal: false,
   readme: 'none',
   out: path.resolve(__dirname, './api'),
-  entryDocument: 'index.md',
+  entryFileName: 'index.md',
   hideBreadcrumbs: false,
-  hideInPageTOC: true,
   preserveAnchorCasing: true,
 }
 
@@ -108,7 +107,7 @@ async function exists(path) {
  */
 function prependYAML(contents, vars) {
   return contents
-    .replace(/^/, toYAML(vars) + '\n\n')
+    .replace(/^/, `${toYAML(vars)}\n\n`)
     .replace(/[\r\n]{3,}/g, '\n\n')
 }
 

diff --git a/packages/playground/package.json b/packages/playground/package.json
@@ -9,14 +9,13 @@
     "preview": "vite preview --port 4173"
   },
   "dependencies": {
-    "vue": "~3.4.38"
+    "vue": "~3.5.13"
   },
   "devDependencies": {
     "@types/node": "^20.17.7",
     "@vitejs/plugin-vue": "^5.2.0",
-    "@vue/compiler-sfc": "~3.4.38",
-    "@vue/tsconfig": "^0.5.1",
-    "typescript": "~5.3.3",
+    "@vue/compiler-sfc": "~3.5.13",
+    "@vue/tsconfig": "^0.6.0",
     "vite": "^5.4.11",
     "vue-router": "workspace:*",
     "vue-tsc": "^2.1.10"

diff --git a/packages/router/package.json b/packages/router/package.json
@@ -126,8 +126,8 @@
     "@types/jsdom": "^21.1.7",
     "@types/nightwatch": "^2.3.32",
     "@vitejs/plugin-vue": "^5.2.0",
-    "@vue/compiler-sfc": "~3.4.38",
-    "@vue/server-renderer": "~3.4.38",
+    "@vue/compiler-sfc": "~3.5.13",
+    "@vue/server-renderer": "~3.5.13",
     "@vue/test-utils": "^2.4.6",
     "browserstack-local": "^1.5.5",
     "chromedriver": "^131.0.1",
@@ -143,8 +143,7 @@
     "rollup": "^3.29.5",
     "rollup-plugin-analyzer": "^4.0.0",
     "rollup-plugin-typescript2": "^0.36.0",
-    "typescript": "~5.6.3",
     "vite": "^5.4.11",
-    "vue": "~3.4.38"
+    "vue": "~3.5.13"
   }
 }
diff --git a/packages/router/src/RouterLink.ts b/packages/router/src/RouterLink.ts
@@ -234,7 +234,6 @@ export function useLink<Name extends keyof RouteMap = keyof RouteMap>(
         typeof document !== 'undefined' &&
         'startViewTransition' in document
       ) {
-        // @ts-ignore: this fails with Vitest, FIXME: remove it
         document.startViewTransition(() => p)
       }
       return p