feat: filter pages in mergePageMetaData to exclude sub-package pages #258 (#259)

* feat: filter pages in mergePageMetaData to exclude sub-package pages

* fix: enhance mergePageMetaData to handle sub-package pages and update tests

* fix: optimize subPageAbsolutePaths collection in mergePageMetaData

* chore: remove commented console log in generate.spec.ts

Author: hairyf

packages/core/src/context.ts

@@ -250,6 +250,13 @@ export class PageContext {
   }
 
   async mergePageMetaData() {
+    // 收集所有子包中的页面绝对路径
+    const subPageAbsolutePaths = Array.from(this.subPages.values()).flatMap(v => Array.from(v.keys()))
+
+    // 过滤掉属于子包的页面
+    for (const subPageAbsolutePath of subPageAbsolutePaths)
+      this.pages.delete(subPageAbsolutePath)
+
     const pageMetaData = await this.parsePages(this.pages, 'main', this.pagesGlobConfig?.pages)
 
     this.pageMetaData = pageMetaData

packages/playground/src/pages/pages-internal-sub/index.vue

@@ -0,0 +1,5 @@
+<template>
+  <div>
+    this is pages-internal-sub
+  </div>
+</template>

packages/playground/src/uni-pages.d.ts

@@ -23,7 +23,8 @@ type _LocationUrl =
   "/pages/define-page/yaml" |
   "/pages-sub/index" |
   "/pages-sub/about/index" |
-  "/pages-sub/about/your";
+  "/pages-sub/about/your" |
+  "/pages/pages-internal-sub/index";
 
 interface NavigateToOptions {
   url: _LocationUrl;

packages/playground/vite.config.ts

@@ -16,7 +16,7 @@ export default defineConfig({
       dts: 'src/uni-pages.d.ts',
       homePage: 'pages/index',
       debug: true,
-      subPackages: ['src/pages-sub', 'src/pages-sub2'],
+      subPackages: ['src/pages-sub', 'src/pages-sub2', 'src/pages/pages-internal-sub'],
       // configSource: [
       //   {
       //     files: 'vite.config',

test/files.spec.ts

@@ -24,6 +24,7 @@ describe('get files', () => {
         "i18n.vue",
         "index.nvue",
         "index.vue",
+        "pages-internal-sub/index.vue",
         "test-json.vue",
         "test-jsonc-with-comment.vue",
         "test-yaml.vue",

test/generate.spec.ts

@@ -23,9 +23,11 @@ const pagesGlobConfig: UserPagesConfig = {
 
 describe('generate routes', () => {
   it('vue - pages snapshot', async () => {
-    const ctx = new PageContext({ dir: 'packages/playground/src/pages', homePage: 'pages/index' })
+    const ctx = new PageContext({ dir: 'packages/playground/src/pages', homePage: 'pages/index', subPackages: ['packages/playground/src/pages/pages-internal-sub'] })
     await ctx.scanPages()
+    await ctx.scanSubPages()
     await ctx.mergePageMetaData()
+
     const routes = ctx.resolveRoutes()
 
     expect(routes).toMatchInlineSnapshot(`
@@ -173,9 +175,10 @@ describe('generate routes', () => {
   })
 
   it('vue - not merge pages snapshot', async () => {
-    const ctx = new PageContext({ dir: 'packages/playground/src/pages', mergePages: false })
+    const ctx = new PageContext({ dir: 'packages/playground/src/pages', mergePages: false, subPackages: ['packages/playground/src/pages/pages-internal-sub'] })
     await ctx.scanPages()
     ctx.pagesGlobConfig = pagesGlobConfig
+    await ctx.scanSubPages()
     await ctx.mergePageMetaData()
     const routes = ctx.resolveRoutes()