docs(router): autoCodeSplitting does not split pendingComponent by default - #8593
tedserbinski wants to merge 1 commit into
Conversation
|
|
Navigate logical layers of code changes, visualize relationships, and explore their blast radius. 🧰 Additional context used📚 Code guidelines (2)No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configuration
📒 Files selected for processing (2)
Included review availability: This review used your included allowance. Your plan provides up to 10 included reviews per hour; 9 remain after this review. 📝 WalkthroughWalkthroughThe code-splitting documentation now states that ChangesCode-splitting documentation
Priority: ⬇️ Low Estimated code review effort: 1 (Trivial) | ~3 minutes Change: Other Suggested reviewers: Merge Risk: ⚪ Minimal · up to The documentation accurately explains the default chunking and how to split Architecture SummaryArchitecture risk: 🔵 Low · up to The change affects 2 systems. Changed systems: Architecture concerns Review detailsSystems and components
Before / after behavior
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
🎯 Changes
Two pages say or imply that
autoCodeSplittingsplitspendingComponent, but the plugin's default groupings leave it in the route's main chunk:docs/router/guide/code-splitting.mdlists "Pending Component" under non-critical configuration, then saysautoCodeSplittingsplits route files "based on the non-critical route configuration mentioned above".packages/router-core/skills/router-core/code-splitting/SKILL.mdlistspendingComponentunder "What Gets Split (Non-Critical)".defaultCodeSplitGroupingsinpackages/router-plugin/src/core/constants.tsis[['component'], ['errorComponent'], ['notFoundComponent']], anddocs/router/guide/automatic-code-splitting.mdalready documents exactly that. I checked a production build on@tanstack/router-plugin1.168.40: a route'spendingComponentstays in its route chunk.This PR changes wording only:
code-splitting.md: after theautoCodeSplittingsentence, one paragraph saying the default splitscomponent,errorComponentandnotFoundComponent, thatpendingComponentstays in the route's main chunk unless a split grouping includes it, and a link to "What gets code split?" in the automatic code-splitting guide.SKILL.md: the list is renamed "What Can Be Split (Non-Critical)", with a note giving the default groupings and how to addpendingComponent(codeSplitGroupingsorcodeSplittingOptions.defaultBehavior).✅ Checklist
🚀 Release Impact
Summary by CodeRabbit