feat: rename pagesMap to routes, revert page meta back to route meta

e2e/docs/.vuepress/config.ts

@@ -54,11 +54,11 @@ export default defineUserConfig({
   theme: e2eTheme(),
 
   extendsPage: (page) => {
-    if (page.path === '/page-data/meta.html') {
-      page.meta = {
+    if (page.path === '/page-data/route-meta.html') {
+      page.routeMeta = {
         a: 1,
         b: 2,
-        ...page.meta,
+        ...page.routeMeta,
       }
     }
   },

e2e/docs/404.md

@@ -1,4 +1,4 @@
 ---
-meta:
+routeMeta:
   notFound: true
 ---

e2e/docs/page-data/meta.md → e2e/docs/page-data/route-meta.md

@@ -1,5 +1,5 @@
 ---
-meta:
+routeMeta:
   a: 0
   c: 3
 ---

e2e/docs/router/resolve-route.md

@@ -0,0 +1,43 @@
+## resolve
+
+### Path
+
+#### Index
+
+- Clean URL: {{ JSON.stringify(resolveRoute('/')) }}
+- HTML: {{ JSON.stringify(resolveRoute('/index.html')) }}
+- Markdown: {{ JSON.stringify(resolveRoute('/README.md')) }}
+
+#### Non-Index
+
+- Clean URL: {{ JSON.stringify(resolveRoute('/router/resolve-route')) }}
+- HTML: {{ JSON.stringify(resolveRoute('/router/resolve-route.html')) }}
+- Markdown: {{ JSON.stringify(resolveRoute('/router/resolve-route.md')) }}
+
+#### Non-ASCII
+
+- Clean URL: {{ JSON.stringify(resolveRoute('/routes/non-ascii-paths/中文目录名/中文文件名')) }}
+- HTML: {{ JSON.stringify(resolveRoute('/routes/non-ascii-paths/中文目录名/中文文件名.html')) }}
+- Markdown: {{ JSON.stringify(resolveRoute('/routes/non-ascii-paths/中文目录名/中文文件名.md')) }}
+
+#### Non-ASCII Encoded
+
+- Clean URL: {{ JSON.stringify(resolveRoute(encodeURI('/routes/non-ascii-paths/中文目录名/中文文件名'))) }}
+- HTML: {{ JSON.stringify(resolveRoute(encodeURI('/routes/non-ascii-paths/中文目录名/中文文件名.html'))) }}
+- Markdown: {{ JSON.stringify(resolveRoute(encodeURI('/routes/non-ascii-paths/中文目录名/中文文件名.md'))) }}
+
+#### Non-Existent
+
+- Clean URL: {{ JSON.stringify(resolveRoute('/non-existent')) }}
+- HTML: {{ JSON.stringify(resolveRoute('/non-existent.html')) }}
+- Markdown: {{ JSON.stringify(resolveRoute('/non-existent.md')) }}
+
+#### Route Meta
+
+- Clean URL: {{ JSON.stringify(resolveRoute('/page-data/route-meta')) }}
+- HTML: {{ JSON.stringify(resolveRoute('/page-data/route-meta.html')) }}
+- Markdown: {{ JSON.stringify(resolveRoute('/page-data/route-meta.md')) }}
+
+<script setup>
+import { resolveRoute } from 'vuepress/client'
+</script>

e2e/tests/router/resolve-route.cy.ts

@@ -0,0 +1,59 @@
+const testCases = [
+  {
+    selector: '#index',
+    expected: {
+      path: '/',
+      meta: {},
+    },
+  },
+  {
+    selector: '#non-index',
+    expected: {
+      path: '/router/resolve-route.html',
+      meta: {},
+    },
+  },
+  {
+    selector: '#non-ascii',
+    expected: {
+      path: encodeURI('/routes/non-ascii-paths/中文目录名/中文文件名.html'),
+      meta: {},
+    },
+  },
+  {
+    selector: '#non-ascii-encoded',
+    expected: {
+      path: encodeURI('/routes/non-ascii-paths/中文目录名/中文文件名.html'),
+      meta: {},
+    },
+  },
+  {
+    selector: '#non-existent',
+    expected: {
+      path: '/non-existent.html',
+      meta: { notFound: true },
+    },
+  },
+  {
+    selector: '#route-meta',
+    expected: {
+      path: '/page-data/route-meta.html',
+      meta: { a: 0, b: 2, c: 3 },
+    },
+  },
+]
+
+const parseResolvedRouteFromElement = (el: Cypress.JQueryWithSelector) =>
+  JSON.parse(/: (\{.*\})\s*$/.exec(el.text())![1])
+
+it('should resolve routes correctly', () => {
+  cy.visit('/router/resolve-route.html')
+
+  testCases.forEach(({ selector, expected }) => {
+    cy.get(`.e2e-theme-content ${selector} + ul > li`).each((el) => {
+      const resolvedRoute = parseResolvedRouteFromElement(el)
+      expect(resolvedRoute.path).to.equal(expected.path)
+      expect(resolvedRoute.meta).to.deep.equal(expected.meta)
+    })
+  })
+})

packages/cli/src/commands/dev/handlePageAdd.ts

@@ -2,7 +2,7 @@ import {
   createPage,
   preparePage,
   preparePageComponent,
-  preparePagesMap,
+  prepareRoutes,
 } from '@vuepress/core'
 import type { App, Page } from '@vuepress/core'
 
@@ -33,8 +33,8 @@ export const handlePageAdd = async (
   await preparePageComponent(app, page)
   await preparePage(app, page)
 
-  // prepare pages entry
-  await preparePagesMap(app)
+  // prepare routes file
+  await prepareRoutes(app)
 
   return page
 }

packages/cli/src/commands/dev/handlePageChange.ts

@@ -2,7 +2,7 @@ import {
   createPage,
   preparePage,
   preparePageComponent,
-  preparePagesMap,
+  prepareRoutes,
 } from '@vuepress/core'
 import type { App, Page } from '@vuepress/core'
 
@@ -37,12 +37,12 @@ export const handlePageChange = async (
   await preparePage(app, pageNew)
 
   const isPathChanged = pageOld.path !== pageNew.path
-  const isMetaChanged =
-    JSON.stringify(pageOld.meta) !== JSON.stringify(pageNew.meta)
+  const isRouteMetaChanged =
+    JSON.stringify(pageOld.routeMeta) !== JSON.stringify(pageNew.routeMeta)
 
-  // prepare pages map if the path or meta is changed
-  if (isPathChanged || isMetaChanged) {
-    await preparePagesMap(app)
+  // prepare routes file if the path or route meta is changed
+  if (isPathChanged || isRouteMetaChanged) {
+    await prepareRoutes(app)
   }
 
   return [pageOld, pageNew]

packages/cli/src/commands/dev/handlePageUnlink.ts

@@ -1,4 +1,4 @@
-import { preparePagesMap } from '@vuepress/core'
+import { prepareRoutes } from '@vuepress/core'
 import type { App, Page } from '@vuepress/core'
 
 /**
@@ -21,8 +21,8 @@ export const handlePageUnlink = async (
   // remove the old page
   app.pages.splice(pageIndex, 1)
 
-  // re-prepare page files
-  await preparePagesMap(app)
+  // re-prepare routes file
+  await prepareRoutes(app)
 
   return page
 }

packages/client/package.json

@@ -59,7 +59,7 @@
     "external": [
       "@internal/clientConfigs",
       "@internal/layoutComponents",
-      "@internal/pagesMap",
+      "@internal/routes",
       "@internal/siteData"
     ],
     "format": [

packages/client/src/components/Content.ts

@@ -1,6 +1,6 @@
 import { computed, defineAsyncComponent, defineComponent, h } from 'vue'
 import { usePageData } from '../composables/index.js'
-import { resolvePage } from '../router/index.js'
+import { resolveRoute } from '../router/index.js'
 
 /**
  * Markdown rendered content
@@ -20,8 +20,8 @@ export const Content = defineComponent({
   setup(props) {
     const pageData = usePageData()
     const pageComponent = computed(() => {
-      const page = resolvePage(props.path || pageData.value.path)
-      return defineAsyncComponent(() => page.loader().then(({ comp }) => comp))
+      const route = resolveRoute(props.path || pageData.value.path)
+      return defineAsyncComponent(() => route.loader().then(({ comp }) => comp))
     })
 
     return () => h(pageComponent.value)

packages/client/src/components/VPLink.ts

@@ -2,7 +2,7 @@ import { h } from 'vue'
 import type { FunctionalComponent, VNode } from 'vue'
 import { useRouter } from 'vue-router'
 import { withBase } from '../helpers/index.js'
-import { resolvePagePath } from '../router/index.js'
+import { resolveRoutePath } from '../router/index.js'
 
 /**
  * Forked from https://github.com/vuejs/router/blob/941b2131e80550009e5221d4db9f366b1fea3fd5/packages/router/src/RouterLink.ts#L293
@@ -35,7 +35,7 @@ export const VPLink: FunctionalComponent<
   }
 > = ({ to = '' }, { slots }) => {
   const router = useRouter()
-  const path = withBase(resolvePagePath(to))
+  const path = withBase(resolveRoutePath(to))
 
   return h(
     'a',

packages/client/src/composables/index.ts

@@ -5,8 +5,8 @@ export * from './pageHead.js'
 export * from './pageHeadTitle.js'
 export * from './pageLang.js'
 export * from './pageLayout.js'
-export * from './pagesMap.js'
 export * from './routeLocale.js'
+export * from './routes.js'
 export * from './siteData.js'
 export * from './siteLocaleData.js'
 export * from './updateHead.js'

packages/client/src/composables/routes.ts

@@ -0,0 +1,11 @@
+import { redirects, routes } from '../router/index.js'
+
+/**
+ * Returns the ref of pages map
+ */
+export const useRedirects = (): typeof redirects => redirects
+
+/**
+ * Returns the ref of routes map
+ */
+export const useRoutes = (): typeof routes => routes