From c4ae151de563f0a91f68f034386b9dfaec6c25b1 Mon Sep 17 00:00:00 2001
From: Horu <73709188+HigherOrderLogic@users.noreply.github.com>
Date: Tue, 13 Aug 2024 07:16:04 +1000
Subject: [PATCH] feat(nuxt): allow organising pages within route groups
 (#28276)

---
 docs/2.guide/2.directory-structure/1.pages.md | 16 ++++++++++
 packages/nuxt/src/pages/utils.ts              | 32 ++++++++++++++++---
 .../pages-override-meta-disabled.test.ts.snap | 28 ++++++++++++++++
 .../pages-override-meta-enabled.test.ts.snap  | 19 +++++++++++
 packages/nuxt/test/pages.test.ts              | 31 ++++++++++++++++++
 test/basic.test.ts                            |  8 +++++
 .../basic/pages/(new-group)/group-page.vue    |  5 +++
 .../nested-group/(deep-group)/group-page.vue  |  5 +++
 .../nested-group/(index-group)/index.vue      |  5 +++
 .../more-nested/(more-deep)/group-page.vue    |  5 +++
 10 files changed, 150 insertions(+), 4 deletions(-)
 create mode 100644 test/fixtures/basic/pages/(new-group)/group-page.vue
 create mode 100644 test/fixtures/basic/pages/nested-group/(deep-group)/group-page.vue
 create mode 100644 test/fixtures/basic/pages/nested-group/(index-group)/index.vue
 create mode 100644 test/fixtures/basic/pages/nested-group/more-nested/(more-deep)/group-page.vue

diff --git a/docs/2.guide/2.directory-structure/1.pages.md b/docs/2.guide/2.directory-structure/1.pages.md
index 283846201d..1367f6f871 100644
--- a/docs/2.guide/2.directory-structure/1.pages.md
+++ b/docs/2.guide/2.directory-structure/1.pages.md
@@ -226,6 +226,22 @@ definePageMeta({
 
 :link-example{to="/docs/examples/routing/pages"}
 
+## Route Groups
+
+In some cases, you may want to group a set of routes together in a way which doesn't affect file-based routing. For this purpose, you can put files in a folder which is wrapped in parentheses - `(` and `)`.
+
+For example:
+
+```bash [Directory structure]
+-| pages/
+---| index.vue
+---| (marketing)/
+-----| about.vue
+-----| contact.vue
+```
+
+This will produce `/`, `/about` and `/contact` pages in your app. The `marketing` group is ignored for purposes of your URL structure.
+
 ## Page Metadata
 
 You might want to define metadata for each route in your app. You can do this using the `definePageMeta` macro, which will work both in `<script>` and in `<script setup>`:
diff --git a/packages/nuxt/src/pages/utils.ts b/packages/nuxt/src/pages/utils.ts
index 75400bcdc8..08c86afeaa 100644
--- a/packages/nuxt/src/pages/utils.ts
+++ b/packages/nuxt/src/pages/utils.ts
@@ -23,6 +23,7 @@ enum SegmentParserState {
   dynamic,
   optional,
   catchall,
+  group,
 }
 
 enum SegmentTokenType {
@@ -30,6 +31,7 @@ enum SegmentTokenType {
   dynamic,
   optional,
   catchall,
+  group,
 }
 
 interface SegmentToken {
@@ -115,7 +117,13 @@ export function generateRoutesFromFiles (files: ScannedFile[], options: Generate
       const segment = segments[i]
 
       const tokens = parseSegment(segment)
-      const segmentName = tokens.map(({ value }) => value).join('')
+
+      // Skip group segments
+      if (tokens.every(token => token.type === SegmentTokenType.group)) {
+        continue
+      }
+
+      const segmentName = tokens.map(({ value, type }) => type === SegmentTokenType.group ? '' : value).join('')
 
       // ex: parent/[slug].vue -> parent-slug
       route.name += (route.name && '/') + segmentName
@@ -298,7 +306,9 @@ function getRoutePath (tokens: SegmentToken[]): string {
           ? `:${token.value}()`
           : token.type === SegmentTokenType.catchall
             ? `:${token.value}(.*)*`
-            : encodePath(token.value).replace(/:/g, '\\:'))
+            : token.type === SegmentTokenType.group
+              ? ''
+              : encodePath(token.value).replace(/:/g, '\\:'))
     )
   }, '/')
 }
@@ -328,7 +338,9 @@ function parseSegment (segment: string) {
             ? SegmentTokenType.dynamic
             : state === SegmentParserState.optional
               ? SegmentTokenType.optional
-              : SegmentTokenType.catchall,
+              : state === SegmentParserState.catchall
+                ? SegmentTokenType.catchall
+                : SegmentTokenType.group,
       value: buffer,
     })
 
@@ -343,6 +355,8 @@ function parseSegment (segment: string) {
         buffer = ''
         if (c === '[') {
           state = SegmentParserState.dynamic
+        } else if (c === '(') {
+          state = SegmentParserState.group
         } else {
           i--
           state = SegmentParserState.static
@@ -353,6 +367,9 @@ function parseSegment (segment: string) {
         if (c === '[') {
           consumeBuffer()
           state = SegmentParserState.dynamic
+        } else if (c === '(') {
+          consumeBuffer()
+          state = SegmentParserState.group
         } else {
           buffer += c
         }
@@ -361,6 +378,7 @@ function parseSegment (segment: string) {
       case SegmentParserState.catchall:
       case SegmentParserState.dynamic:
       case SegmentParserState.optional:
+      case SegmentParserState.group:
         if (buffer === '...') {
           buffer = ''
           state = SegmentParserState.catchall
@@ -375,10 +393,16 @@ function parseSegment (segment: string) {
             consumeBuffer()
           }
           state = SegmentParserState.initial
+        } else if (c === ')' && state === SegmentParserState.group) {
+          if (!buffer) {
+            throw new Error('Empty group')
+          } else {
+            consumeBuffer()
+          }
+          state = SegmentParserState.initial
         } else if (PARAM_CHAR_RE.test(c)) {
           buffer += c
         } else {
-
           // console.debug(`[pages]Ignored character "${c}" while building param "${buffer}" from "segment"`)
         }
         break
diff --git a/packages/nuxt/test/__snapshots__/pages-override-meta-disabled.test.ts.snap b/packages/nuxt/test/__snapshots__/pages-override-meta-disabled.test.ts.snap
index 8ab4d0263f..96bea24bd9 100644
--- a/packages/nuxt/test/__snapshots__/pages-override-meta-disabled.test.ts.snap
+++ b/packages/nuxt/test/__snapshots__/pages-override-meta-disabled.test.ts.snap
@@ -339,6 +339,34 @@
       "redirect": "mockMeta?.redirect",
     },
   ],
+  "should handle route groups": [
+    {
+      "alias": "mockMeta?.alias || []",
+      "component": "() => import("pages/(foo)/index.vue").then(m => m.default || m)",
+      "meta": "mockMeta || {}",
+      "name": "mockMeta?.name ?? "index"",
+      "path": "mockMeta?.path ?? "/"",
+      "redirect": "mockMeta?.redirect",
+    },
+    {
+      "alias": "mockMeta?.alias || []",
+      "children": [
+        {
+          "alias": "mockMeta?.alias || []",
+          "component": "() => import("pages/(bar)/about/index.vue").then(m => m.default || m)",
+          "meta": "mockMeta || {}",
+          "name": "mockMeta?.name ?? "about"",
+          "path": "mockMeta?.path ?? """,
+          "redirect": "mockMeta?.redirect",
+        },
+      ],
+      "component": "() => import("pages/(foo)/about.vue").then(m => m.default || m)",
+      "meta": "mockMeta || {}",
+      "name": "mockMeta?.name ?? undefined",
+      "path": "mockMeta?.path ?? "/about"",
+      "redirect": "mockMeta?.redirect",
+    },
+  ],
   "should handle trailing slashes with index routes": [
     {
       "alias": "mockMeta?.alias || []",
diff --git a/packages/nuxt/test/__snapshots__/pages-override-meta-enabled.test.ts.snap b/packages/nuxt/test/__snapshots__/pages-override-meta-enabled.test.ts.snap
index 42c8e219f6..861a18f16f 100644
--- a/packages/nuxt/test/__snapshots__/pages-override-meta-enabled.test.ts.snap
+++ b/packages/nuxt/test/__snapshots__/pages-override-meta-enabled.test.ts.snap
@@ -234,6 +234,25 @@
       "path": ""/parent"",
     },
   ],
+  "should handle route groups": [
+    {
+      "component": "() => import("pages/(foo)/index.vue").then(m => m.default || m)",
+      "name": ""index"",
+      "path": ""/"",
+    },
+    {
+      "children": [
+        {
+          "component": "() => import("pages/(bar)/about/index.vue").then(m => m.default || m)",
+          "name": ""about"",
+          "path": """",
+        },
+      ],
+      "component": "() => import("pages/(foo)/about.vue").then(m => m.default || m)",
+      "name": "mockMeta?.name",
+      "path": ""/about"",
+    },
+  ],
   "should handle trailing slashes with index routes": [
     {
       "children": [
diff --git a/packages/nuxt/test/pages.test.ts b/packages/nuxt/test/pages.test.ts
index 9bd89de9ad..3b307387be 100644
--- a/packages/nuxt/test/pages.test.ts
+++ b/packages/nuxt/test/pages.test.ts
@@ -601,6 +601,37 @@ describe('pages:generateRoutesFromFiles', () => {
         },
       ],
     },
+    {
+      description: 'should handle route groups',
+      files: [
+        { path: `${pagesDir}/(foo)/index.vue` },
+        { path: `${pagesDir}/(foo)/about.vue` },
+        { path: `${pagesDir}/(bar)/about/index.vue` },
+      ],
+      output: [
+        {
+          name: 'index',
+          path: '/',
+          file: `${pagesDir}/(foo)/index.vue`,
+          meta: undefined,
+          children: [],
+        },
+        {
+          path: '/about',
+          file: `${pagesDir}/(foo)/about.vue`,
+          meta: undefined,
+          children: [
+
+            {
+              name: 'about',
+              path: '',
+              file: `${pagesDir}/(bar)/about/index.vue`,
+              children: [],
+            },
+          ],
+        },
+      ],
+    },
   ]
 
   const normalizedResults: Record<string, any> = {}
diff --git a/test/basic.test.ts b/test/basic.test.ts
index 401b986cea..a05493d7ff 100644
--- a/test/basic.test.ts
+++ b/test/basic.test.ts
@@ -570,6 +570,14 @@ describe('pages', () => {
 
     await normalInitialPage.close()
   })
+
+  it('groups routes', async () => {
+    for (const targetRoute of ['/group-page', '/nested-group/group-page', '/nested-group']) {
+      const { status } = await fetch(targetRoute)
+
+      expect(status).toBe(200)
+    }
+  })
 })
 
 describe('nuxt composables', () => {
diff --git a/test/fixtures/basic/pages/(new-group)/group-page.vue b/test/fixtures/basic/pages/(new-group)/group-page.vue
new file mode 100644
index 0000000000..171e0d1ed9
--- /dev/null
+++ b/test/fixtures/basic/pages/(new-group)/group-page.vue
@@ -0,0 +1,5 @@
+<template>
+  <div>
+    Hello from new group
+  </div>
+</template>
diff --git a/test/fixtures/basic/pages/nested-group/(deep-group)/group-page.vue b/test/fixtures/basic/pages/nested-group/(deep-group)/group-page.vue
new file mode 100644
index 0000000000..3319baeb2f
--- /dev/null
+++ b/test/fixtures/basic/pages/nested-group/(deep-group)/group-page.vue
@@ -0,0 +1,5 @@
+<template>
+  <div>
+    Page deep in group
+  </div>
+</template>
diff --git a/test/fixtures/basic/pages/nested-group/(index-group)/index.vue b/test/fixtures/basic/pages/nested-group/(index-group)/index.vue
new file mode 100644
index 0000000000..b0555ed6f4
--- /dev/null
+++ b/test/fixtures/basic/pages/nested-group/(index-group)/index.vue
@@ -0,0 +1,5 @@
+<template>
+  <div>
+    Index page of a group
+  </div>
+</template>
diff --git a/test/fixtures/basic/pages/nested-group/more-nested/(more-deep)/group-page.vue b/test/fixtures/basic/pages/nested-group/more-nested/(more-deep)/group-page.vue
new file mode 100644
index 0000000000..70c10786ae
--- /dev/null
+++ b/test/fixtures/basic/pages/nested-group/more-nested/(more-deep)/group-page.vue
@@ -0,0 +1,5 @@
+<template>
+  <div>
+    Page deep, deep in group
+  </div>
+</template>