Merge branch 'main' into markdown-links

Mister-Hope · Mister-Hope · commit 1227d2061c9c · 2024-05-13T14:53:22.000+08:00
diff --git a/e2e/package.json b/e2e/package.json
@@ -19,13 +19,13 @@
     "@vuepress-e2e/conditional-exports": "file:./modules/conditional-exports",
     "@vuepress/bundler-vite": "workspace:*",
     "@vuepress/bundler-webpack": "workspace:*",
-    "sass": "^1.74.1",
-    "sass-loader": "^14.1.1",
-    "vue": "^3.4.21",
+    "sass": "^1.75.0",
+    "sass-loader": "^14.2.1",
+    "vue": "^3.4.23",
     "vuepress": "workspace:*"
   },
   "devDependencies": {
-    "@playwright/test": "^1.43.0",
+    "@playwright/test": "^1.43.1",
     "anywhere": "^1.6.0",
     "cross-env": "^7.0.3"
   }
diff --git a/package.json b/package.json
@@ -30,12 +30,12 @@
   },
   "prettier": "prettier-config-vuepress",
   "devDependencies": {
-    "@commitlint/cli": "^19.2.1",
-    "@commitlint/config-conventional": "^19.1.0",
+    "@commitlint/cli": "^19.2.2",
+    "@commitlint/config-conventional": "^19.2.2",
     "@commitlint/types": "^19.0.3",
-    "@types/node": "^20.12.5",
+    "@types/node": "^20.12.7",
     "@types/webpack-env": "^1.18.4",
-    "@vitest/coverage-istanbul": "^1.4.0",
+    "@vitest/coverage-istanbul": "^1.5.0",
     "bumpp": "^9.4.0",
     "conventional-changelog-cli": "^4.1.0",
     "eslint": "^8.57.0",
@@ -49,11 +49,11 @@
     "sort-package-json": "^2.10.0",
     "tsconfig-vuepress": "^4.5.0",
     "tsup": "^8.0.2",
-    "typescript": "^5.4.4",
-    "vite": "~5.2.8",
-    "vitest": "^1.4.0"
+    "typescript": "^5.4.5",
+    "vite": "~5.2.10",
+    "vitest": "^1.5.0"
   },
-  "packageManager": "pnpm@8.15.6",
+  "packageManager": "pnpm@9.0.4",
   "engines": {
     "node": ">=18.16.0"
   }
diff --git a/packages/bundler-vite/package.json b/packages/bundler-vite/package.json
@@ -42,10 +42,10 @@
     "connect-history-api-fallback": "^2.0.0",
     "postcss": "^8.4.38",
     "postcss-load-config": "^5.0.3",
-    "rollup": "^4.14.1",
-    "vite": "~5.2.8",
-    "vue": "^3.4.21",
-    "vue-router": "^4.3.0"
+    "rollup": "^4.16.0",
+    "vite": "~5.2.10",
+    "vue": "^3.4.23",
+    "vue-router": "^4.3.2"
   },
   "publishConfig": {
     "access": "public"
diff --git a/packages/bundler-vite/src/plugins/vuepressMainPlugin.ts b/packages/bundler-vite/src/plugins/vuepressMainPlugin.ts
@@ -82,6 +82,8 @@ import 'vuepress/client-app'
         host: app.options.host,
         port: app.options.port,
         open: app.options.open,
+        // ref: https://github.com/vitejs/vite/issues/15784#issuecomment-1923683823
+        fs: { cachedChecks: false },
       },
       build: {
         ssr: isServer,
diff --git a/packages/bundler-webpack/package.json b/packages/bundler-webpack/package.json
@@ -45,18 +45,18 @@
     "autoprefixer": "^10.4.19",
     "chokidar": "^3.6.0",
     "copy-webpack-plugin": "^12.0.2",
-    "css-loader": "^7.0.0",
+    "css-loader": "^7.1.1",
     "esbuild-loader": "~4.1.0",
     "express": "^4.19.2",
     "html-webpack-plugin": "^5.6.0",
-    "mini-css-extract-plugin": "^2.8.1",
+    "mini-css-extract-plugin": "^2.9.0",
     "postcss": "^8.4.38",
     "postcss-csso": "^6.0.1",
     "postcss-loader": "^8.1.1",
-    "style-loader": "^3.3.4",
-    "vue": "^3.4.21",
+    "style-loader": "^4.0.0",
+    "vue": "^3.4.23",
     "vue-loader": "^17.4.2",
-    "vue-router": "^4.3.0",
+    "vue-router": "^4.3.2",
     "webpack": "^5.91.0",
     "webpack-chain": "^6.5.1",
     "webpack-dev-server": "^5.0.4",
diff --git a/packages/client/package.json b/packages/client/package.json
@@ -39,8 +39,8 @@
   "dependencies": {
     "@vue/devtools-api": "^6.6.1",
     "@vuepress/shared": "workspace:*",
-    "vue": "^3.4.21",
-    "vue-router": "^4.3.0"
+    "vue": "^3.4.23",
+    "vue-router": "^4.3.2"
   },
   "publishConfig": {
     "access": "public"
diff --git a/packages/core/package.json b/packages/core/package.json
@@ -35,7 +35,7 @@
     "@vuepress/markdown": "workspace:*",
     "@vuepress/shared": "workspace:*",
     "@vuepress/utils": "workspace:*",
-    "vue": "^3.4.21"
+    "vue": "^3.4.23"
   },
   "publishConfig": {
     "access": "public"
diff --git a/packages/core/src/page/resolvePageChunkInfo.ts b/packages/core/src/page/resolvePageChunkInfo.ts
@@ -1,4 +1,4 @@
-import { path, sanitizeFileName } from '@vuepress/utils'
+import { path, transformPathToFileName } from '@vuepress/utils'
 import type { App } from '../types/index.js'
 
 /**
@@ -17,7 +17,7 @@ export const resolvePageChunkInfo = ({
 } => {
   const chunkFilePathRelative = path.join('pages', `${htmlFilePathRelative}.js`)
   const chunkFilePath = app.dir.temp(chunkFilePathRelative)
-  const chunkName = sanitizeFileName(path.basename(htmlFilePathRelative))
+  const chunkName = transformPathToFileName(htmlFilePathRelative)
 
   return {
     chunkFilePath,
diff --git a/packages/core/src/page/resolvePagePermalink.ts b/packages/core/src/page/resolvePagePermalink.ts
@@ -20,14 +20,23 @@ export const resolvePagePermalink = ({
   pathInferred: string | null
   pathLocale: string
 }): string | null => {
-  // use permalink in frontmatter directly
+  // frontmatter.permalink has the highest priority
+  if (frontmatter.permalink === null) {
+    return null
+  }
   if (isString(frontmatter.permalink)) {
     return frontmatter.permalink
   }
 
-  // get permalink pattern
-  const permalinkPattern = getPermalinkPattern({ app, frontmatter })
-  if (permalinkPattern === null) {
+  // frontmatter.permalinkPattern has higher priority than app.options.permalinkPattern
+  if (frontmatter.permalinkPattern === null) {
+    return null
+  }
+
+  const permalinkPattern =
+    frontmatter.permalinkPattern || app.options.permalinkPattern
+
+  if (!isString(permalinkPattern)) {
     return null
   }
 
@@ -45,22 +54,3 @@ export const resolvePagePermalink = ({
 
   return ensureLeadingSlash(link)
 }
-
-/**
- * Get permalink pattern from frontmatter or app options
- */
-const getPermalinkPattern = ({
-  app,
-  frontmatter,
-}: {
-  app: App
-  frontmatter: PageFrontmatter
-}): string | null => {
-  if (frontmatter.permalinkPattern === null) {
-    return null
-  }
-  if (isString(frontmatter.permalinkPattern)) {
-    return frontmatter.permalinkPattern
-  }
-  return app.options.permalinkPattern
-}
diff --git a/packages/core/tests/page/resolvePagePermalink.spec.ts b/packages/core/tests/page/resolvePagePermalink.spec.ts
@@ -36,6 +36,21 @@ describe('core > page > resolvePagePermalink', () => {
       expect(resolved).toBe('/frontmatter')
     })
 
+    it('should return null', () => {
+      const resolved = resolvePagePermalink({
+        app: appWithPermalinkPattern,
+        frontmatter: {
+          permalink: null,
+        },
+        slug: '',
+        date: '',
+        pathInferred: '/inferred',
+        pathLocale: '',
+      })
+
+      expect(resolved).toBe(null)
+    })
+
     it('should use permalinkPattern in frontmatter', () => {
       const resolved = resolvePagePermalink({
         app,
diff --git a/packages/markdown/package.json b/packages/markdown/package.json
@@ -31,15 +31,15 @@
     "clean": "rimraf dist"
   },
   "dependencies": {
-    "@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/plugin-component": "^2.1.2",
+    "@mdit-vue/plugin-frontmatter": "^2.1.2",
+    "@mdit-vue/plugin-headers": "^2.1.2",
+    "@mdit-vue/plugin-sfc": "^2.1.2",
+    "@mdit-vue/plugin-title": "^2.1.2",
+    "@mdit-vue/plugin-toc": "^2.1.2",
+    "@mdit-vue/shared": "^2.1.2",
     "@mdit-vue/types": "^2.1.0",
-    "@types/markdown-it": "^14.0.0",
+    "@types/markdown-it": "^14.0.1",
     "@types/markdown-it-emoji": "^2.0.5",
     "@vuepress/shared": "workspace:*",
     "@vuepress/utils": "workspace:*",
diff --git a/packages/shared/src/types/page.ts b/packages/shared/src/types/page.ts
@@ -62,7 +62,7 @@ export type PageFrontmatter<
   head?: HeadConfig[]
   lang?: string
   layout?: string
-  permalink?: string
+  permalink?: string | null
   permalinkPattern?: string | null
   routeMeta?: Record<string, unknown>
   title?: string
diff --git a/packages/shared/src/utils/index.ts b/packages/shared/src/utils/index.ts
@@ -2,6 +2,7 @@ export * from './dedupeHead.js'
 export * from './ensureLeadingSlash.js'
 export * from './ensureEndingSlash.js'
 export * from './formatDateString.js'
+export * from './inferRoutePath.js'
 export * from './isLinkExternal.js'
 export * from './isLinkHttp.js'
 export * from './isLinkWithProtocol.js'
diff --git a/packages/shared/src/utils/inferRoutePath.ts b/packages/shared/src/utils/inferRoutePath.ts
@@ -1,3 +1,6 @@
+/**
+ * Infer route path according to the given (markdown file) path
+ */
 export const inferRoutePath = (path: string): string => {
   // if the pathname is empty or ends with `/`, return as is
   if (!path || path.endsWith('/')) return path
diff --git a/packages/shared/src/utils/isLinkExternal.ts b/packages/shared/src/utils/isLinkExternal.ts
@@ -1,23 +1,13 @@
-import { isLinkHttp } from './isLinkHttp.js'
+import { isLinkWithProtocol } from './isLinkWithProtocol.js'
 
 const markdownLinkRegexp = /.md((\?|#).*)?$/
 
 /**
  * Determine a link is external or not
  */
-export const isLinkExternal = (link: string, base = '/'): boolean => {
-  if (isLinkHttp(link)) {
-    return true
-  }
-
+export const isLinkExternal = (link: string, base = '/'): boolean =>
+  isLinkWithProtocol(link) ||
   // absolute link that does not start with `base` and does not end with `.md`
-  if (
-    link.startsWith('/') &&
+  (link.startsWith('/') &&
     !link.startsWith(base) &&
-    !markdownLinkRegexp.test(link)
-  ) {
-    return true
-  }
-
-  return false
-}
+    !markdownLinkRegexp.test(link))
diff --git a/packages/shared/tests/isLinkExternal.spec.ts b/packages/shared/tests/isLinkExternal.spec.ts
@@ -20,13 +20,13 @@ const testCases: [
   [['//foobar.com/base/README.md', '/base/'], true],
 
   // links with other protocols
-  [['mailto:foobar', '/base/'], false],
-  [['tel:foobar', '/base/'], false],
-  [['ftp://foobar.com'], false],
-  [['ftp://foobar.com', '/base/'], false],
-  [['ftp://foobar.com/base/README.md'], false],
-  [['ftp://foobar.com/base/README.md', '/base/'], false],
-  [['ms-windows-store://home', '/base/'], false],
+  [['mailto:foobar', '/base/'], true],
+  [['tel:foobar', '/base/'], true],
+  [['ftp://foobar.com'], true],
+  [['ftp://foobar.com', '/base/'], true],
+  [['ftp://foobar.com/base/README.md'], true],
+  [['ftp://foobar.com/base/README.md', '/base/'], true],
+  [['ms-windows-store://home', '/base/'], true],
 
   // absolute links
   [['/foo/bar'], false],
diff --git a/packages/shared/tests/normalizeRoutePath.spec.ts b/packages/shared/tests/normalizeRoutePath.spec.ts
diff --git a/packages/utils/src/module/index.ts b/packages/utils/src/module/index.ts
diff --git a/packages/utils/src/module/transformPathToFileName.ts b/packages/utils/src/module/transformPathToFileName.ts
diff --git a/packages/vuepress/package.json b/packages/vuepress/package.json
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
