fix(unplugin): Avoid generating empty routes by FrontEndDog · Pull Request #2642 · vuejs/router

FrontEndDog · 2026-02-26T09:27:49Z

Summary by CodeRabbit

Release Notes

Tests
- Added test coverage for nested route structures with parent file configurations.
Bug Fixes
- Enhanced route tree cleanup to properly remove empty wrapper nodes when children are removed.

netlify · 2026-02-26T09:27:55Z

✅ Deploy Preview for vue-router canceled.

Name	Link
🔨 Latest commit	`1190e6f`
🔍 Latest deploy log	https://app.netlify.com/projects/vue-router/deploys/69eb3cb2d5c40f0008cc4626

coderabbitai · 2026-02-26T09:28:16Z

Note

Reviews paused

It looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

@coderabbitai resume to resume automatic reviews.
@coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

▶️ Resume reviews
🔍 Trigger review

📝 Walkthrough

Walkthrough

This PR adds a test case for handling nested _parent files in route generation and implements recursive cleanup logic to delete empty non-matchable parent nodes when child nodes are removed from the route tree.

Changes

Cohort / File(s)	Summary
Test Coverage `packages/router/src/unplugin/codegen/generateRouteRecords.spec.ts`	Adds test scenario verifying that nested `_parent` files are skipped when a parent index file exists at a higher level, preventing generation of empty routes (e.g., `/users/settings`).
Tree Cleanup Logic `packages/router/src/unplugin/core/tree.ts`	Implements recursive deletion of parent nodes in `TreeNode.delete()` when they become empty and non-matchable, cascading cleanup upward through the tree structure.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Suggested reviewers

posva

Poem

🐰 Branches pruned, the tree takes shape,
Empty folders fade to escape,
Parents whisper when children depart,
Cleaning from the bottom, a tidy art! 🌳

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title 'fix(unplugin): Avoid generating empty routes' directly and concisely describes the main objective of the PR.
Linked Issues check	✅ Passed	The PR addresses the core requirement from issue `#2641` by modifying route generation and tree deletion logic to prevent empty routes, with added test coverage for the fix.
Out of Scope Changes check	✅ Passed	All changes are directly related to fixing empty route generation: test additions verify the fix and tree deletion logic prevents orphaned empty nodes.
Docstring Coverage	✅ Passed	Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

Create PR with unit tests

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

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

coderabbitai

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)

packages/router/src/unplugin/codegen/generateRouteRecords.ts (1)
22-28: ⚠️ Potential issue | 🟠 Major

Missing .filter(Boolean) for root-level children.

The same empty-route scenario that's fixed at line 101 can occur here. If a root-level child node is non-matchable with no children (lines 33-35), generateRouteRecords returns '', and the join would produce invalid JavaScript like [,\n{...}] or [{...},\n].
Proposed fix to apply the same filter
   if (node.isRoot()) {
     return `[
 ${node
   .getChildrenSorted()
   .map(child => generateRouteRecords(child, options, importsMap, indent + 1))
+  .filter(Boolean)
   .join(',\n')}
 ]`
   }
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@packages/router/src/unplugin/codegen/generateRouteRecords.ts` around lines 22
- 28, The root branch in generateRouteRecords (when node.isRoot()) maps over
node.getChildrenSorted() but doesn't filter out empty return values from
generateRouteRecords, so non-matchable children can produce '' and create
invalid array output; update the root branch to first filter out falsy results
(e.g., .filter(Boolean)) before mapping and joining (same approach used
elsewhere in generateRouteRecords), keeping the rest of the call using
generateRouteRecords(child, options, importsMap, indent + 1) so empty strings
are excluded from the joined array.

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Outside diff comments:
In `@packages/router/src/unplugin/codegen/generateRouteRecords.ts`:
- Around line 22-28: The root branch in generateRouteRecords (when
node.isRoot()) maps over node.getChildrenSorted() but doesn't filter out empty
return values from generateRouteRecords, so non-matchable children can produce
'' and create invalid array output; update the root branch to first filter out
falsy results (e.g., .filter(Boolean)) before mapping and joining (same approach
used elsewhere in generateRouteRecords), keeping the rest of the call using
generateRouteRecords(child, options, importsMap, indent + 1) so empty strings
are excluded from the joined array.

ℹ️ Review info

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 1832ea1 and 646bbf5.

📒 Files selected for processing (1)

packages/router/src/unplugin/codegen/generateRouteRecords.ts

Copilot

Pull request overview

Fixes route code generation in the router unplugin to avoid emitting “empty routes” when route nodes are deleted (e.g., via beforeWriteFiles) but empty intermediate folders remain in the route tree.

Changes:

Filters out falsy generated child route-record strings during children array generation to prevent empty array slots.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

posva

Thanks for the PR!
This is probably not the right fix. Maybe the delete is leaving some unused nodes in the tree or not cleaning itself from the parent.

A unit test for the tree is also needed

pkg-pr-new · 2026-02-26T09:46:05Z

Open in StackBlitz

npm i https://pkg.pr.new/vue-router@2642

commit: 1190e6f

codecov · 2026-02-26T09:50:02Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 85.96%. Comparing base (4713069) to head (1190e6f).
⚠️ Report is 53 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2642      +/-   ##
==========================================
+ Coverage   85.58%   85.96%   +0.37%     
==========================================
  Files          86       88       +2     
  Lines        9960    10087     +127     
  Branches     2285     2321      +36     
==========================================
+ Hits         8524     8671     +147     
+ Misses       1423     1405      -18     
+ Partials       13       11       -2

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

FrontEndDog · 2026-02-26T10:05:53Z

Thanks for the PR! This is probably not the right fix. Maybe the delete is leaving some unused nodes in the tree or not cleaning itself from the parent.

A unit test for the tree is also needed

Additional supplements

unplugin-vue-router@0.19.2 does not have this issue.

These codes were newly added in vue-router@5

I will attempt to repair it using the correct method.

coderabbitai

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@packages/router/src/unplugin/codegen/generateRouteRecords.ts`:
- Around line 22-28: The current loop in generateRouteRecords.ts mutates
node.children during forEach (child.delete()) and won't remove parents that
become empty after their children are pruned; change to a safe post-order
pruning: traverse children first (recursively prune each child), collect
children to delete (using child.isMatchable() and child.children.size === 0
checks after recursive pruning), then delete them in a separate pass using
child.delete(); alternatively implement a separate cleanup pass (pruneNode) that
returns whether a node should be deleted so parent callers can remove now-empty
non-matchable nodes. Ensure references to node.children, child.isMatchable(),
and child.delete() are used in the new post-order logic.

ℹ️ Review info

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 646bbf5 and a07b7fe.

📒 Files selected for processing (1)

packages/router/src/unplugin/codegen/generateRouteRecords.ts

…neration

…e parent nodes

FrontEndDog · 2026-02-27T02:07:30Z

I have revised the logic for skipping lone parent nodes and added unit test.

FrontEndDog · 2026-02-27T02:25:55Z

I discovered an issue during subsequent testing, if the file structure is test1/test2/Test.vue, After the path "Test.vue" is deleted , There will be an lone route for test1, maybe I should modify the delete method of nodeTree.

…e records

coderabbitai

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@packages/router/src/unplugin/core/tree.ts`:
- Around line 212-216: The cascade delete can climb to the root and trigger the
"Cannot delete the root node" error; modify the condition around the recursive
delete (the block using this.parent.isMatchable(), this.parent.children.size and
calling this.parent.delete()) to guard against deleting the root—e.g. check that
this.parent is not the root (use whatever root predicate exists or ensure
this.parent.parent !== undefined) before calling this.parent.delete(); update
the condition so the root node is never passed to delete().

ℹ️ Review info

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 0f610c3 and e41658f.

📒 Files selected for processing (1)

packages/router/src/unplugin/core/tree.ts

Copilot

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

…te records

…ble node is deleted

FrontEndDog · 2026-02-27T08:19:50Z

Just a moment. I've found some other issues. I'll fix them.

FrontEndDog · 2026-02-27T10:00:31Z

Hi @posva ,I find a new problem.
The directory structure is as follows:

router tree.ts add log

When I try to delete route start with a capital letter in beforeWriteFiles, an error is reported.

FrontEndDog · 2026-02-27T10:10:38Z

Maybe this line of code should be deleted or modify the judgment logic of the root node

When deleting /admin for the second time, due to the execution of this.parent = undefined, /admin may be mistakenly recognized as the root node.

…hable node is deleted

FrontEndDog · 2026-02-27T10:54:32Z

I have already dealt with all the issues.

FrontEndDog · 2026-03-04T08:09:31Z

Hi @posva I have already dealt with all the issues. Could you spare some time to review this PR.

posva

Thanks!

fix(unplugin): Avoid generating empty routes

646bbf5

Copilot AI review requested due to automatic review settings February 26, 2026 09:27

Copilot started reviewing on behalf of FrontEndDog February 26, 2026 09:28 View session

coderabbitai Bot reviewed Feb 26, 2026

View reviewed changes

Copilot AI reviewed Feb 26, 2026

View reviewed changes

Comment thread packages/router/src/unplugin/codegen/generateRouteRecords.ts

Comment thread packages/router/src/unplugin/codegen/generateRouteRecords.ts

Comment thread packages/router/src/unplugin/codegen/generateRouteRecords.ts

posva requested changes Feb 26, 2026

View reviewed changes

fix(generateRouteRecords): remove lone children nodes from route records

a07b7fe

coderabbitai Bot reviewed Feb 27, 2026

View reviewed changes

Comment thread packages/router/src/unplugin/codegen/generateRouteRecords.ts Outdated

FrontEndDog added 2 commits February 27, 2026 09:58

fix(generateRouteRecords): skip nested lone _parent files in route ge…

9dcdf60

…neration

fix(generateRouteRecords): correct comment to reflect deletion of lon…

0f610c3

…e parent nodes

FrontEndDog requested a review from posva February 27, 2026 02:07

fix(generateRouteRecords): skip deletion of lone parent nodes in rout…

e41658f

…e records

FrontEndDog requested a review from Copilot February 27, 2026 02:57

Copilot started reviewing on behalf of FrontEndDog February 27, 2026 02:58 View session

coderabbitai Bot reviewed Feb 27, 2026

View reviewed changes

Comment thread packages/router/src/unplugin/core/tree.ts Outdated

Copilot AI reviewed Feb 27, 2026

View reviewed changes

Comment thread packages/router/src/unplugin/core/tree.ts Outdated

Comment thread packages/router/src/unplugin/codegen/generateRouteRecords.spec.ts

fix(TreeNode): prevent deletion of root nodes without children in rou…

c4e2148

…te records

posva requested changes Feb 27, 2026

View reviewed changes

Comment thread packages/router/src/unplugin/codegen/generateRouteRecords.spec.ts

fix(tree): add test for removing parent when last child of non-matcha…

4f9708a

…ble node is deleted

FrontEndDog requested a review from posva February 27, 2026 06:37

fix(tree): remove unnecessary insertion of parent node in test case

665ce2e

fix(tree): add test for removing parent when last child of a non-matc…

2505de9

…hable node is deleted

refactor: deleteChild

1190e6f

posva approved these changes Apr 24, 2026

View reviewed changes

posva merged commit 10a8b77 into vuejs:main Apr 24, 2026
10 checks passed

Uh oh!

Conversation

FrontEndDog commented Feb 26, 2026 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Release Notes

Uh oh!

netlify Bot commented Feb 26, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for vue-router canceled.

Uh oh!

coderabbitai Bot commented Feb 26, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviews paused

Walkthrough

Changes

Estimated code review effort

Suggested reviewers

Poem

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

posva left a comment

Choose a reason for hiding this comment

Uh oh!

pkg-pr-new Bot commented Feb 26, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov Bot commented Feb 26, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

FrontEndDog commented Feb 26, 2026

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

FrontEndDog commented Feb 27, 2026

Uh oh!

FrontEndDog commented Feb 27, 2026

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

FrontEndDog commented Feb 27, 2026

Uh oh!

FrontEndDog commented Feb 27, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

FrontEndDog commented Feb 27, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

FrontEndDog commented Feb 27, 2026

Uh oh!

FrontEndDog commented Mar 4, 2026

Uh oh!

posva left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

FrontEndDog commented Feb 26, 2026 •

edited by coderabbitai Bot

Loading

netlify Bot commented Feb 26, 2026 •

edited

Loading

coderabbitai Bot commented Feb 26, 2026 •

edited

Loading

pkg-pr-new Bot commented Feb 26, 2026 •

edited

Loading

codecov Bot commented Feb 26, 2026 •

edited

Loading

FrontEndDog commented Feb 27, 2026 •

edited

Loading

FrontEndDog commented Feb 27, 2026 •

edited

Loading