feat: add e2e test

e2e/docs/.vuepress/config.ts

@@ -28,4 +28,13 @@ export default defineUserConfig({
  process.env.E2E_BUNDLER === 'webpack' ? webpackBundler() : viteBundler(),
 
  theme: e2eTheme(),
+
+ extendsPage: (page) => {
+ if (page.path === '/page-data/meta.html')
+ page.meta = {
+ a: 1,
+ b: 2,
+ ...page.meta,
+ }
+ },
 })

e2e/docs/page-data/meta.md

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

e2e/docs/router.md

@@ -0,0 +1,38 @@
+## GetPagesPath
+
+<ul class="get-pages-path">
+ <li v-for="path in pagesPath">
+ {{path}}
+ </li>
+</ul>
+
+## isPageExist
+
+<div class="is-page-exist">
+
+- /: {{isPageExist('/')}}
+- /README.md: {{isPageExist('/README.md')}}
+- /index.html: {{isPageExist('/index.html')}}
+- /not-exist: {{isPageExist('/not-exist')}}
+- /not-exist.html: {{isPageExist('/not-exist.html')}}
+- /not-exist.md: {{isPageExist('/not-exist.md')}}
+- /zh/: {{isPageExist('/zh/')}}
+- /zh: {{isPageExist('/zh')}}
+
+</div>
+
+## resolve
+
+<div class="resolve">
+
+- Clean url: {{JSON.stringify(resolve('/page-data/meta'))}}
+- HTML: {{JSON.stringify(resolve('/page-data/meta.html'))}}
+- Markdown: {{JSON.stringify(resolve('/page-data/meta.md'))}}
+
+</div>
+
+<script setup>
+import { getPagesPath, isPageExist, pagesMap, resolve } from '@vuepress/client'
+
+const pagesPath = getPagesPath();
+</script>

e2e/tests/router.cy.ts

@@ -0,0 +1,60 @@
+context('router', () => {
+ it('getPagesPath', () => {
+ cy.visit('/router.html')
+
+ const paths = [
+ '/',
+ '/layouts/custom-layout.html',
+ '/layouts/layout.html',
+ '/markdown/code-blocks.html',
+ '/markdown/emoji.html',
+ '/markdown/import-code-blocks.html',
+ '/markdown/toc.html',
+ '/markdown/vue-components.html',
+ '/markdown/links/bar.html',
+ '/markdown/links/baz.html',
+ '/markdown/links/foo.html',
+ '/page-data/frontmatter.html',
+ '/page-data/headers.html',
+ '/page-data/lang.html',
+ '/page-data/meta.html',
+ '/page-data/permalink.html',
+ '/page-data/title-from-frontmatter.html',
+ '/page-data/title-from-h1.html',
+ '/router.html',
+ '/zh/',
+ '/404.html',
+ ]
+
+ cy.get('.e2e-theme-content ul.get-pages-path li').each((el) => {
+ expect(paths.includes(el.text())).to.equal(true)
+ })
+ })
+
+ it('isPageExist', () => {
+ cy.visit('/router.html')
+ const results = [
+ '/: true',
+ '/README.md: true',
+ '/index.html: true',
+ '/not-exist: false',
+ '/not-exist.html: false',
+ '/not-exist.md: false',
+ '/zh/: true',
+ '/zh: false',
+ ]
+
+ cy.get('.e2e-theme-content .is-page-exist ul li').each((el) => {
+ expect(results.includes(el.text())).to.equal(true)
+ })
+ })
+
+ it('resolve', () => {
+ cy.visit('/router.html')
+ const result = { path: '/page-data/meta.html', meta: { a: 0, b: 2, c: 3 } }
+
+ cy.get('.e2e-theme-content .resolve ul li').each((el) => {
+ expect(el.text()).to.contain(JSON.stringify(result))
+ })
+ })
+})

packages/client/src/composables/pagesMap.ts

@@ -3,7 +3,7 @@ import {
  redirectsMap as redirectsMapRaw,
 } from '@internal/pagesMap'
 import type { PageRedirectsMap, PagesMap } from '@internal/pagesMap'
-import { ref } from 'vue'
+import { shallowRef } from 'vue'
 import type { Ref } from 'vue'
 
 /**
@@ -19,12 +19,12 @@ export type PageRedirectsRef = Ref<PageRedirectsMap>
 /**
  * Global pages map ref
  */
-export const pagesMap: PagesMapRef = ref(pagesMapRaw)
+export const pagesMap: PagesMapRef = shallowRef(pagesMapRaw)
 
 /**
  * Global pages map ref
  */
-export const redirectsMap: PageRedirectsRef = ref(redirectsMapRaw)
+export const redirectsMap: PageRedirectsRef = shallowRef(redirectsMapRaw)
 
 /**
  * Returns the ref of pages map

packages/client/src/helpers/router.ts

@@ -7,7 +7,7 @@ import { resolvers } from '../resolvers.js'
  *
  * @returns all paths of pages
  */
-export const getPagesPath = (): string[] => Object.keys(pagesMap.value)
+export const getPagesPath = (): string[] => Array.from(pagesMap.value.keys())
 
 /**
  * Check whether the page exists