Merge branch 'main' into siteLocaleData

vuepress · Apr 11, 2024 · 1774670 · 1774670
2 parents 5701209 + d837efc
commit 1774670
Show file tree

Hide file tree

Showing 20 changed files with 501 additions and 436 deletions.
diff --git a/.commitlintrc.cjs → commitlint.config.ts b/.commitlintrc.cjs → commitlint.config.ts
@@ -1,16 +1,17 @@
-const fs = require('fs')
-const path = require('path')
+import * as fs from 'node:fs'
+import * as path from 'node:path'
+import type { UserConfig } from '@commitlint/types'
 
-const getSubDirectories = (dir) =>
+const getSubDirectories = (dir: string): string[] =>
   fs
     .readdirSync(dir)
     .filter((item) => fs.statSync(path.join(dir, item)).isDirectory())
 const packages = getSubDirectories(path.resolve(__dirname, 'packages'))
 
-module.exports = {
+export default {
   extends: ['@commitlint/config-conventional'],
   rules: {
-    'scope-enum': [2, 'always', packages],
+    'scope-enum': [2, 'always', [...packages, 'e2e']],
     'footer-max-line-length': [0],
   },
-}
+} satisfies UserConfig
diff --git a/e2e/docs/router/navigation.md b/e2e/docs/router/navigation.md
@@ -0,0 +1,16 @@
+<button id="home" @click="goHome">Home</button>
+<button id="404" @click="go404">404</button>
+
+<script setup lang="ts">
+import { useRouter } from 'vuepress/client';
+
+const router = useRouter();
+
+const goHome = () => {
+  router.push('/?home=true');
+}
+
+const go404 = () => {
+  router.push('/404.html#404');
+}
+</script>
diff --git a/e2e/package.json b/e2e/package.json
@@ -21,15 +21,15 @@
     "@vuepress-e2e/conditional-exports": "file:./modules/conditional-exports",
     "@vuepress/bundler-vite": "workspace:*",
     "@vuepress/bundler-webpack": "workspace:*",
-    "sass": "^1.72.0",
+    "sass": "^1.74.1",
     "sass-loader": "^14.1.1",
     "vue": "^3.4.21",
     "vuepress": "workspace:*"
   },
   "devDependencies": {
     "anywhere": "^1.6.0",
     "cross-env": "^7.0.3",
-    "cypress": "^13.7.1",
+    "cypress": "^13.7.2",
     "process": "^0.11.10",
     "start-server-and-test": "^2.0.3"
   }

diff --git a/e2e/tests/router/navigation.cy.ts b/e2e/tests/router/navigation.cy.ts
@@ -0,0 +1,21 @@
+it('should preserve query', () => {
+  const E2E_BASE = Cypress.env('E2E_BASE')
+
+  cy.visit('/router/navigation.html')
+
+  cy.get('#home').click()
+
+  cy.location('pathname').should('eq', E2E_BASE)
+  cy.location('search').should('eq', '?home=true')
+})
+
+it('should preserve hash', () => {
+  const E2E_BASE = Cypress.env('E2E_BASE')
+
+  cy.visit('/router/navigation.html')
+
+  cy.get('#404').click()
+
+  cy.location('pathname').should('eq', `${E2E_BASE}404.html`)
+  cy.location('hash').should('eq', '#404')
+})
diff --git a/package.json b/package.json
@@ -32,7 +32,8 @@
   "devDependencies": {
     "@commitlint/cli": "^19.2.1",
     "@commitlint/config-conventional": "^19.1.0",
-    "@types/node": "^20.11.30",
+    "@commitlint/types": "^19.0.3",
+    "@types/node": "^20.12.5",
     "@types/webpack-env": "^1.18.4",
     "@vitest/coverage-istanbul": "^1.4.0",
     "bumpp": "^9.4.0",
@@ -46,14 +47,14 @@
     "prettier": "^3.2.5",
     "prettier-config-vuepress": "^4.4.0",
     "rimraf": "^5.0.5",
-    "sort-package-json": "^2.8.0",
+    "sort-package-json": "^2.10.0",
     "tsconfig-vuepress": "^4.5.0",
     "tsup": "^8.0.2",
-    "typescript": "^5.4.3",
-    "vite": "~5.2.2",
+    "typescript": "^5.4.4",
+    "vite": "~5.2.8",
     "vitest": "^1.4.0"
   },
-  "packageManager": "pnpm@8.15.5",
+  "packageManager": "pnpm@8.15.6",
   "engines": {
     "node": ">=18.16.0"
   }

diff --git a/packages/bundler-vite/package.json b/packages/bundler-vite/package.json
@@ -42,8 +42,8 @@
     "connect-history-api-fallback": "^2.0.0",
     "postcss": "^8.4.38",
     "postcss-load-config": "^5.0.3",
-    "rollup": "^4.13.0",
-    "vite": "~5.2.2",
+    "rollup": "^4.14.1",
+    "vite": "~5.2.8",
     "vue": "^3.4.21",
     "vue-router": "^4.3.0"
   },

diff --git a/packages/bundler-vite/src/plugins/vuepressMainPlugin.ts b/packages/bundler-vite/src/plugins/vuepressMainPlugin.ts
@@ -209,7 +209,7 @@ const resolveDefine = async ({
     // enable options API by default
     __VUE_OPTIONS_API__: JSON.stringify(true),
     __VUE_PROD_DEVTOOLS__: JSON.stringify(app.env.isDebug),
-    __VUE_PROD_HYDRATION_MISMATCH_DETAILS__: JSON.stringify(false),
+    __VUE_PROD_HYDRATION_MISMATCH_DETAILS__: JSON.stringify(app.env.isDebug),
   }
 
   // override vite built-in define config in debug mode

diff --git a/packages/bundler-webpack/package.json b/packages/bundler-webpack/package.json
@@ -45,9 +45,9 @@
     "autoprefixer": "^10.4.19",
     "chokidar": "^3.6.0",
     "copy-webpack-plugin": "^12.0.2",
-    "css-loader": "^6.10.0",
+    "css-loader": "^7.0.0",
     "esbuild-loader": "~4.1.0",
-    "express": "^4.19.1",
+    "express": "^4.19.2",
     "html-webpack-plugin": "^5.6.0",
     "mini-css-extract-plugin": "^2.8.1",
     "postcss": "^8.4.38",

diff --git a/packages/bundler-webpack/src/config/handlePluginDefine.ts b/packages/bundler-webpack/src/config/handlePluginDefine.ts
@@ -27,7 +27,7 @@ export const handlePluginDefine = async ({
       // enable options API by default
       __VUE_OPTIONS_API__: JSON.stringify(true),
       __VUE_PROD_DEVTOOLS__: JSON.stringify(app.env.isDebug),
-      __VUE_PROD_HYDRATION_MISMATCH_DETAILS__: JSON.stringify(false),
+      __VUE_PROD_HYDRATION_MISMATCH_DETAILS__: JSON.stringify(app.env.isDebug),
     },
   ])
 

diff --git a/packages/cli/package.json b/packages/cli/package.json
@@ -41,7 +41,7 @@
     "@vuepress/utils": "workspace:*",
     "cac": "^6.7.14",
     "chokidar": "^3.6.0",
-    "envinfo": "^7.11.1",
+    "envinfo": "^7.12.0",
     "esbuild": "~0.20.2"
   },
   "devDependencies": {

diff --git a/packages/client/src/router/createVueRouter.ts b/packages/client/src/router/createVueRouter.ts
@@ -40,9 +40,9 @@ export const createVueRouter = (): Router => {
   // and save page data to route meta
   router.beforeResolve(async (to, from): Promise<string | void> => {
     if (to.path !== from.path || from === START_LOCATION) {
-      const route = resolveRoute(to.path)
+      const route = resolveRoute(to.fullPath)
 
-      if (route.path !== to.path) {
+      if (route.path !== to.fullPath) {
         return route.path
       }
       const pageChunk = await route.loader()

diff --git a/packages/markdown/package.json b/packages/markdown/package.json
@@ -31,16 +31,16 @@
     "clean": "rimraf dist"
   },
   "dependencies": {
-    "@mdit-vue/plugin-component": "^2.0.0",
-    "@mdit-vue/plugin-frontmatter": "^2.0.0",
-    "@mdit-vue/plugin-headers": "^2.0.0",
-    "@mdit-vue/plugin-sfc": "^2.0.0",
-    "@mdit-vue/plugin-title": "^2.0.0",
-    "@mdit-vue/plugin-toc": "^2.0.0",
-    "@mdit-vue/shared": "^2.0.0",
-    "@mdit-vue/types": "^2.0.0",
-    "@types/markdown-it": "^13.0.7",
-    "@types/markdown-it-emoji": "^2.0.4",
+    "@mdit-vue/plugin-component": "^2.1.0",
+    "@mdit-vue/plugin-frontmatter": "^2.1.0",
+    "@mdit-vue/plugin-headers": "^2.1.0",
+    "@mdit-vue/plugin-sfc": "^2.1.0",
+    "@mdit-vue/plugin-title": "^2.1.0",
+    "@mdit-vue/plugin-toc": "^2.1.0",
+    "@mdit-vue/shared": "^2.1.0",
+    "@mdit-vue/types": "^2.1.0",
+    "@types/markdown-it": "^14.0.0",
+    "@types/markdown-it-emoji": "^2.0.5",
     "@vuepress/shared": "workspace:*",
     "@vuepress/utils": "workspace:*",
     "markdown-it": "^14.1.0",

diff --git a/packages/markdown/src/plugins/assetsPlugin/assetsPlugin.ts b/packages/markdown/src/plugins/assetsPlugin/assetsPlugin.ts
@@ -1,5 +1,5 @@
 import type { PluginWithOptions } from 'markdown-it'
-import type { RenderRule } from 'markdown-it/lib/renderer.js'
+import type { RenderRule } from 'markdown-it/lib/renderer.mjs'
 import type { MarkdownEnv } from '../../types.js'
 import { resolveLink } from './resolveLink.js'
 

diff --git a/packages/markdown/src/plugins/codePlugin/resolveHighlightLines.ts b/packages/markdown/src/plugins/codePlugin/resolveHighlightLines.ts
@@ -1,4 +1,4 @@
-export type HighlightLinesRange = [number, number]
+export type HighlightLinesRange = [start: number, end: number]
 
 /**
  * Resolve highlight-lines ranges from token info

diff --git a/packages/markdown/src/plugins/importCodePlugin/createImportCodeBlockRule.ts b/packages/markdown/src/plugins/importCodePlugin/createImportCodeBlockRule.ts
@@ -1,5 +1,5 @@
 import { path } from '@vuepress/utils'
-import type { RuleBlock } from 'markdown-it/lib/parser_block.js'
+import type ParserBlock from 'markdown-it/lib/parser_block.mjs'
 import type { ImportCodePluginOptions } from './importCodePlugin.js'
 import type { ImportCodeTokenMeta } from './types.js'
 
@@ -13,7 +13,9 @@ const START_CODES = [64, 91, 99, 111, 100, 101]
 const SYNTAX_RE = /^@\[code(?:{(?:(\d+)?-(\d+)?)})?(?: ([^\]]+))?\]\(([^)]*)\)/
 
 export const createImportCodeBlockRule =
-  ({ handleImportPath = (str) => str }: ImportCodePluginOptions): RuleBlock =>
+  ({
+    handleImportPath = (str) => str,
+  }: ImportCodePluginOptions): ParserBlock.RuleBlock =>
   (state, startLine, endLine, silent): boolean => {
     // if it's indented more than 3 spaces, it should be a code block
     /* istanbul ignore if */

diff --git a/packages/markdown/src/plugins/linksPlugin/linksPlugin.ts b/packages/markdown/src/plugins/linksPlugin/linksPlugin.ts
@@ -1,6 +1,6 @@
 import { isLinkExternal, normalizeRoutePath } from '@vuepress/shared'
 import type { PluginWithOptions } from 'markdown-it'
-import type Token from 'markdown-it/lib/token.js'
+import type Token from 'markdown-it/lib/token.mjs'
 import type { MarkdownEnv } from '../../types.js'
 import { resolvePaths } from './resolvePaths.js'
 

diff --git a/packages/markdown/src/types.ts b/packages/markdown/src/types.ts
@@ -2,6 +2,7 @@ import type { MarkdownSfcBlocks } from '@mdit-vue/plugin-sfc'
 import type { MarkdownItEnv } from '@mdit-vue/types'
 import type { PageFrontmatter, PageHeader } from '@vuepress/shared'
 import type MarkdownIt from 'markdown-it'
+import type { Options } from 'markdown-it'
 import type {
   AnchorPluginOptions,
   AssetsPluginOptions,
@@ -18,7 +19,7 @@ import type {
 export type Markdown = MarkdownIt
 export type { MarkdownSfcBlocks }
 
-export interface MarkdownOptions extends MarkdownIt.Options {
+export interface MarkdownOptions extends Options {
   anchor?: false | AnchorPluginOptions
   assets?: false | AssetsPluginOptions
   code?: false | CodePluginOptions

diff --git a/packages/shared/package.json b/packages/shared/package.json
@@ -33,7 +33,7 @@
     "clean": "rimraf dist"
   },
   "dependencies": {
-    "@mdit-vue/types": "^2.0.0"
+    "@mdit-vue/types": "^2.1.0"
   },
   "publishConfig": {
     "access": "public"