fix(nuxt): use greedy catchall when `/index` is the last segment #31528

danielroe · 2025-03-25T11:46:59Z

🔗 Linked issue

📚 Description

we don't want to apply the more narrow regexp when there is no following segment, but we neglected to check for /index as a segment (which we ignore) meaning the path matcher we created had too low of a priority

bolt-new-by-stackblitz · 2025-03-25T11:47:02Z

Run & review this pull request in StackBlitz Codeflow.

coderabbitai · 2025-03-25T11:49:26Z

Walkthrough

The changes update the route generation logic and extend the dynamic route configurations within the project. In the utility file, the condition for appending a subsequent segment to the route path now includes an additional check to ensure the segment is not equal to "index". This modification refines how route paths are constructed based on file segment names. In the test file, a new dynamic route is introduced, mapping the [...id]/index.vue file to a catch-all route pattern with the name "id" and a corresponding path pattern of /:id(.*)*. This new route entry, which features an empty children array, is added alongside an existing dynamic route configuration. No modifications were made to the declarations of exported or public entities.

✨ Finishing Touches

📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai plan to trigger planning for file edits and PR creation.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

coderabbitai

Actionable comments posted: 0

🧹 Nitpick comments (1)

packages/nuxt/src/pages/utils.ts (1)
142-142: Consider adding a comment to clarify this condition's purpose

This condition now checks that the next segment is not 'index' to determine whether to use a greedy catchall pattern. Adding a comment would help future developers understand why this special case exists.
-      const routePath = getRoutePath(tokens, segments[i + 1] !== undefined && segments[i + 1] !== 'index')
+      // Use greedy catchall pattern when `/index` is the last segment
+      const hasSucceedingNonIndexSegment = segments[i + 1] !== undefined && segments[i + 1] !== 'index'
+      const routePath = getRoutePath(tokens, hasSucceedingNonIndexSegment)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between d7f5db9 and ac244f1.

⛔ Files ignored due to path filters (2)

packages/nuxt/test/__snapshots__/pages-override-meta-disabled.test.ts.snap is excluded by !**/*.snap
packages/nuxt/test/__snapshots__/pages-override-meta-enabled.test.ts.snap is excluded by !**/*.snap

📒 Files selected for processing (2)

packages/nuxt/src/pages/utils.ts (1 hunks)
packages/nuxt/test/pages.test.ts (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (2)

GitHub Check: build
GitHub Check: code

🔇 Additional comments (2)

packages/nuxt/test/pages.test.ts (2)

611-613: Good test case for the new functionality

This test case properly covers the specific scenario where a catchall route has an index file as the last segment, which is exactly what the PR aims to fix.

616-622: Correct expected output with greedy catchall pattern

The expected output correctly verifies that the greedy catchall pattern (/:id(.*)*) is used when /index is the last segment in a catchall route path, which aligns with the PR objective.

pkg-pr-new · 2025-03-25T11:51:11Z

Open in Stackblitz

@nuxt/kit

npm i https://pkg.pr.new/@nuxt/kit@31528

nuxt

npm i https://pkg.pr.new/nuxt@31528

@nuxt/schema

npm i https://pkg.pr.new/@nuxt/schema@31528

@nuxt/rspack-builder

npm i https://pkg.pr.new/@nuxt/rspack-builder@31528

@nuxt/vite-builder

npm i https://pkg.pr.new/@nuxt/vite-builder@31528

@nuxt/webpack-builder

npm i https://pkg.pr.new/@nuxt/webpack-builder@31528

commit: ac244f1

codspeed-hq · 2025-03-25T12:01:24Z

CodSpeed Performance Report

Merging #31528 will not alter performance

_{Comparing fix/index-segment (ac244f1) with main (d7f5db9)}

Summary

✅ 10 untouched benchmarks

john-psina · 2025-03-25T14:11:50Z

@danielroe Thank you for the fix! I have a couple of questions regarding the availability of these changes:

Will these changes be released only with Nuxt 4, or can we expect them in the next Nuxt 3 release?
Is there any way to use this fix before the official release? I'm wondering if it's possible to install a pre-release version with this fix from the main branch for local development until the changes are officially released.

This would be really helpful for our current development process, as we're actively working with dynamic routes and i18n.

danielroe · 2025-03-25T15:05:39Z

you can expect a patch release this weekend, and before then (once this is cherry picked to 3.x) you can use the nightly channel: https://nuxt.com/docs/guide/going-further/nightly-release-channel

)

fix(nuxt): use greedy catchall when /index is the last segment

ac244f1

danielroe added 3.x bug pages labels Mar 25, 2025

danielroe requested a review from BobbieGoede March 25, 2025 11:46

danielroe self-assigned this Mar 25, 2025

coderabbitai bot reviewed Mar 25, 2025

View reviewed changes

BobbieGoede approved these changes Mar 25, 2025

View reviewed changes

danielroe merged commit c89e603 into main Mar 25, 2025
45 checks passed

danielroe deleted the fix/index-segment branch March 25, 2025 12:10

github-actions bot mentioned this pull request Mar 25, 2025

v4.0.0 #27716

Merged

danielroe added a commit that referenced this pull request Mar 25, 2025

fix(nuxt): use greedy catchall when /index is the last segment (#31528

68c388c

)

github-actions bot mentioned this pull request Mar 25, 2025

v3.16.2 #31463

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

fix(nuxt): use greedy catchall when `/index` is the last segment #31528

fix(nuxt): use greedy catchall when `/index` is the last segment #31528

Uh oh!

danielroe commented Mar 25, 2025

Uh oh!

bolt-new-by-stackblitz bot commented Mar 25, 2025

Uh oh!

coderabbitai bot commented Mar 25, 2025

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Uh oh!

pkg-pr-new bot commented Mar 25, 2025

Uh oh!

codspeed-hq bot commented Mar 25, 2025

Uh oh!

Uh oh!

john-psina commented Mar 25, 2025

Uh oh!

danielroe commented Mar 25, 2025

Uh oh!

Uh oh!

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Uh oh!

fix(nuxt): use greedy catchall when /index is the last segment #31528

fix(nuxt): use greedy catchall when /index is the last segment #31528

Uh oh!

Conversation

danielroe commented Mar 25, 2025

🔗 Linked issue

📚 Description

Uh oh!

bolt-new-by-stackblitz bot commented Mar 25, 2025

Uh oh!

coderabbitai bot commented Mar 25, 2025

Walkthrough

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

pkg-pr-new bot commented Mar 25, 2025

Uh oh!

codspeed-hq bot commented Mar 25, 2025

CodSpeed Performance Report

Merging #31528 will not alter performance

Summary

Uh oh!

Uh oh!

john-psina commented Mar 25, 2025

Uh oh!

danielroe commented Mar 25, 2025

Uh oh!

Uh oh!

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

fix(nuxt): use greedy catchall when `/index` is the last segment #31528

fix(nuxt): use greedy catchall when `/index` is the last segment #31528

CodeRabbit Configuration File (`.coderabbit.yaml`)