docs(solid-router): large-file-based

[birkskyum]

pnpm run test:types
Solid on the left, react on the right

Summary by CodeRabbit

• New Examples
  • Added a new Solid.js example project showcasing file-based routing with TanStack Router, including patterns for dynamic parameters, search parameters, and nested routes. Demonstrates integration with query management and includes TypeScript configuration with development tooling setup.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

Adds a new Solid.js example project demonstrating large-file-based routing at examples/solid/large-file-based/. Includes configuration files, a route generation script creating 100+ route variants, multiple file-based route definitions, and generated route tree structure for TypeScript performance diagnostics.

Changes

Cohort / File(s)	Summary
Project Configuration examples/solid/large-file-based/.gitignore, .vscode/settings.json, tsconfig.json, vite.config.js, postcss.config.mjs	Adds VSCode, TypeScript, Vite, and PostCSS configuration; excludes build artifacts and generated files from watcher and search.
Package & Documentation examples/solid/large-file-based/package.json, README.md	Defines project metadata, scripts (dev, build, gen, test:types), and dependencies; documents example purpose and run instructions.
Application Entry & Styling examples/solid/large-file-based/index.html, src/main.tsx, src/styles.css	Sets up HTML entry point and Solid app root with QueryClient, router configuration, and Tailwind-based styling.
Route Generation examples/solid/large-file-based/src/createRoutes.mjs	Script that reads template routes and generates 100 file-based route variants (absolute, relative, search, params) for performance testing.
Route Files examples/solid/large-file-based/src/routes/__root.tsx, absolute.tsx, index.tsx, linkProps.tsx, relative.tsx, params/route.tsx, params/$paramsPlaceholder.tsx, search/route.tsx, search/searchPlaceholder.tsx	Defines root route with context, index route, and placeholder route implementations demonstrating search parameters, dynamic params, and navigation patterns.
Generated Route Tree examples/solid/large-file-based/src/routeTree.gen.ts	Auto-generated file declaring route interfaces (FileRoutesByFullPath, FileRoutesByTo, FileRoutesById, FileRouteTypes), module augmentation for @tanstack/solid-router, and composed routeTree export with hierarchical children.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

• src/routeTree.gen.ts: Complex auto-generated file with extensive type declarations and module augmentation; verify structure aligns with router expectations.
• src/createRoutes.mjs: Review the variant generation logic, file I/O operations, and template placeholder replacement to ensure correct route file creation.
• Route files consistency: Verify all route files follow expected patterns for component export, Route constant export, and loader/validation usage.

Possibly related PRs

• docs(solid-router): esbuild guide/example #5831: Adds another Solid file-based example project with similar generated routeTree.gen.ts structure and VSCode ignore settings.
• docs(solid-router): webpack example and installation guide #5833: Adds Solid file-based examples featuring comparable routeTree.gen.ts with FileRouteTypes/module augmentation and VSCode configuration.
• test(solid-router): js-only-file-based e2e suite #5626: Introduces Solid file-based routing examples/e2e projects creating generated routeTree files and file-based route module definitions.

Suggested labels

documentation

Suggested reviewers

• brenelz
• schiller-manuel

Poem

🐰 A garden of routes takes shape today,
A hundred files in perfect array,
The Solid framework now on display,
Performance tested in TypeScript's way,
FileTree grows, all branches at play! 🌿

✨ Finishing touches

• 📝 Generate docstrings

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch docs(solid-router)--large-file-based

---

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 5a06540 and 6864270.

⛔ Files ignored due to path filters (1)

• pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml

📒 Files selected for processing (21)

• examples/solid/large-file-based/.gitignore (1 hunks)
• examples/solid/large-file-based/.vscode/settings.json (1 hunks)
• examples/solid/large-file-based/README.md (1 hunks)
• examples/solid/large-file-based/index.html (1 hunks)
• examples/solid/large-file-based/package.json (1 hunks)
• examples/solid/large-file-based/postcss.config.mjs (1 hunks)
• examples/solid/large-file-based/src/createRoutes.mjs (1 hunks)
• examples/solid/large-file-based/src/main.tsx (1 hunks)
• examples/solid/large-file-based/src/routeTree.gen.ts (1 hunks)
• examples/solid/large-file-based/src/routes/__root.tsx (1 hunks)
• examples/solid/large-file-based/src/routes/absolute.tsx (1 hunks)
• examples/solid/large-file-based/src/routes/index.tsx (1 hunks)
• examples/solid/large-file-based/src/routes/linkProps.tsx (1 hunks)
• examples/solid/large-file-based/src/routes/params/$paramsPlaceholder.tsx (1 hunks)
• examples/solid/large-file-based/src/routes/params/route.tsx (1 hunks)
• examples/solid/large-file-based/src/routes/relative.tsx (1 hunks)
• examples/solid/large-file-based/src/routes/search/route.tsx (1 hunks)
• examples/solid/large-file-based/src/routes/search/searchPlaceholder.tsx (1 hunks)
• examples/solid/large-file-based/src/styles.css (1 hunks)
• examples/solid/large-file-based/tsconfig.json (1 hunks)
• examples/solid/large-file-based/vite.config.js (1 hunks)

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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

[nx-cloud]

View your CI Pipeline Execution ↗ for commit 6864270

Command	Status	Duration	Result
nx affected --targets=test:eslint,test:unit,tes...	✅ Succeeded	54s	View ↗
nx run-many --target=build --exclude=examples/*...	✅ Succeeded	1s	View ↗

---

☁️ Nx Cloud last updated this comment at 2025-11-12 19:02:22 UTC

[pkg-pr-new]

More templates

• tanstack-router-react-example-authenticated-routes
• tanstack-router-react-example-authenticated-routes-firebase
• tanstack-router-react-example-basic
• tanstack-router-react-example-basic-default-search-params
• tanstack-router-react-example-basic-devtools-panel
• tanstack-router-react-example-basic-file-based
• tanstack-router-react-example-basic-non-nested-devtools
• tanstack-router-react-example-react-query
• tanstack-router-react-example-basic-react-query-file-based
• tanstack-router-react-example-basic-ssr-file-based
• tanstack-router-react-example-basic-ssr-streaming-file-based
• tanstack-router-react-example-basic-virtual-file-based
• tanstack-router-react-example-basic-virtual-inside-file-based
• tanstack-router-react-example-deferred-data
• tanstack-router-i18n-paraglide
• tanstack-router-react-example-kitchen-sink
• tanstack-router-react-example-kitchen-sink-file-based
• tanstack-router-react-example-kitchen-sink-react-query
• tanstack-router-react-example-kitchen-sink-react-query-file-based
• tanstack-router-react-example-large-file-based
• tanstack-router-react-example-location-masking
• tanstack-router-react-example-navigation-blocking
• tanstack-router-react-example-quickstart
• tanstack-router-react-example-quickstart-esbuild-file-based
• tanstack-router-react-example-quickstart-file-based
• tanstack-router-react-example-quickstart-rspack-file-based
• tanstack-router-react-example-quickstart-webpack-file-based
• router-monorepo-react-query
• router-mono-simple
• router-mono-simple-lazy
• tanstack-router-react-example-scroll-restoration
• tanstack-search-validator-adapters
• tanstack-start-example-bare
• tanstack-start-example-basic
• tanstack-start-example-basic-auth
• tanstack-start-example-basic-cloudflare
• tanstack-start-example-basic-react-query
• tanstack-start-example-basic-static
• tanstack-start-bun-hosting
• tanstack-start-example-clerk-basic
• tanstack-start-example-convex-trellaux
• tanstack-start-example-counter
• tanstack-start-i18n-paraglide
• tanstack-start-example-large
• tanstack-start-example-material-ui
• tanstack-start-streaming-data-from-server-functions
• tanstack-start-example-supabase-basic
• tanstack-start-tailwind-v4
• tanstack-start-example-trellaux
• tanstack-start-example-workos
• tanstack-router-react-example-view-transitions
• tanstack-router-react-example-with-framer-motion
• tanstack-router-react-example-with-trpc
• tanstack-router-react-example-with-trpc-react-query
• tanstack-router-solid-example-authenticated-routes
• tanstack-router-solid-example-authenticated-routes-firebase
• tanstack-router-solid-example-basic
• tanstack-router-solid-example-basic-default-search-params
• tanstack-router-solid-example-basic-devtools-panel
• tanstack-router-solid-example-basic-file-based
• tanstack-router-solid-example-basic-non-nested-devtools
• tanstack-router-solid-example-basic-solid-query
• tanstack-router-solid-example-basic-solid-query-file-based
• tanstack-router-solid-example-basic-ssr-file-based
• tanstack-router-solid-example-basic-ssr-streaming-file-based
• tanstack-router-solid-example-basic-virtual-file-based
• tanstack-router-solid-example-basic-virtual-inside-file-based
• tanstack-router-solid-example-deferred-data
• tanstack-router-solid-example-kitchen-sink
• tanstack-router-solid-example-kitchen-sink-file-based
• tanstack-router-solid-example-kitchen-sink-solid-query
• tanstack-router-solid-example-kitchen-sink-solid-query-file-based
• tanstack-router-solid-example-large-file-based
• tanstack-router-solid-example-location-masking
• tanstack-router-solid-example-quickstart
• tanstack-router-solid-example-quickstart-esbuild-file-based
• tanstack-router-solid-example-quickstart-file-based
• tanstack-router-solid-example-quickstart-rspack-file-based
• tanstack-router-solid-example-quickstart-webpack-file-based
• tanstack-router-solid-example-scroll-restoration
• tanstack-solid-start-example-basic
• tanstack-solid-start-example-basic-auth
• tanstack-solid-start-example-basic-cloudflare
• tanstack-solid-start-example-basic-netlify
• tanstack-solid-start-example-basic-nitro
• tanstack-start-example-basic-solid-query
• tanstack-solid-start-example-basic-static
• tanstack-solid-start-bun-hosting
• tanstack-solid-start-example-convex-better-auth
• tanstack-solid-start-example-counter
• tanstack-solid-start-streaming-data-from-server-functions
• tanstack-solid-start-example-supabase-basic
• tanstack-router-solid-example-view-transitions
• tanstack-router-solid-example-with-framer-motion
• tanstack-router-solid-example-with-trpc

@tanstack/arktype-adapter

npm i https://pkg.pr.new/TanStack/router/@tanstack/arktype-adapter@5842

@tanstack/directive-functions-plugin

npm i https://pkg.pr.new/TanStack/router/@tanstack/directive-functions-plugin@5842

@tanstack/eslint-plugin-router

npm i https://pkg.pr.new/TanStack/router/@tanstack/eslint-plugin-router@5842

@tanstack/history

npm i https://pkg.pr.new/TanStack/router/@tanstack/history@5842

@tanstack/nitro-v2-vite-plugin

npm i https://pkg.pr.new/TanStack/router/@tanstack/nitro-v2-vite-plugin@5842

@tanstack/react-router

npm i https://pkg.pr.new/TanStack/router/@tanstack/react-router@5842

@tanstack/react-router-devtools

npm i https://pkg.pr.new/TanStack/router/@tanstack/react-router-devtools@5842

@tanstack/react-router-ssr-query

npm i https://pkg.pr.new/TanStack/router/@tanstack/react-router-ssr-query@5842

@tanstack/react-start

npm i https://pkg.pr.new/TanStack/router/@tanstack/react-start@5842

@tanstack/react-start-client

npm i https://pkg.pr.new/TanStack/router/@tanstack/react-start-client@5842

@tanstack/react-start-server

npm i https://pkg.pr.new/TanStack/router/@tanstack/react-start-server@5842

@tanstack/router-cli

npm i https://pkg.pr.new/TanStack/router/@tanstack/router-cli@5842

@tanstack/router-core

npm i https://pkg.pr.new/TanStack/router/@tanstack/router-core@5842

@tanstack/router-devtools

npm i https://pkg.pr.new/TanStack/router/@tanstack/router-devtools@5842

@tanstack/router-devtools-core

npm i https://pkg.pr.new/TanStack/router/@tanstack/router-devtools-core@5842

@tanstack/router-generator

npm i https://pkg.pr.new/TanStack/router/@tanstack/router-generator@5842

@tanstack/router-plugin

npm i https://pkg.pr.new/TanStack/router/@tanstack/router-plugin@5842

@tanstack/router-ssr-query-core

npm i https://pkg.pr.new/TanStack/router/@tanstack/router-ssr-query-core@5842

@tanstack/router-utils

npm i https://pkg.pr.new/TanStack/router/@tanstack/router-utils@5842

@tanstack/router-vite-plugin

npm i https://pkg.pr.new/TanStack/router/@tanstack/router-vite-plugin@5842

@tanstack/server-functions-plugin

npm i https://pkg.pr.new/TanStack/router/@tanstack/server-functions-plugin@5842

@tanstack/solid-router

npm i https://pkg.pr.new/TanStack/router/@tanstack/solid-router@5842

@tanstack/solid-router-devtools

npm i https://pkg.pr.new/TanStack/router/@tanstack/solid-router-devtools@5842

@tanstack/solid-router-ssr-query

npm i https://pkg.pr.new/TanStack/router/@tanstack/solid-router-ssr-query@5842

@tanstack/solid-start

npm i https://pkg.pr.new/TanStack/router/@tanstack/solid-start@5842

@tanstack/solid-start-client

npm i https://pkg.pr.new/TanStack/router/@tanstack/solid-start-client@5842

@tanstack/solid-start-server

npm i https://pkg.pr.new/TanStack/router/@tanstack/solid-start-server@5842

@tanstack/start-client-core

npm i https://pkg.pr.new/TanStack/router/@tanstack/start-client-core@5842

@tanstack/start-plugin-core

npm i https://pkg.pr.new/TanStack/router/@tanstack/start-plugin-core@5842

@tanstack/start-server-core

npm i https://pkg.pr.new/TanStack/router/@tanstack/start-server-core@5842

@tanstack/start-static-server-functions

npm i https://pkg.pr.new/TanStack/router/@tanstack/start-static-server-functions@5842

@tanstack/start-storage-context

npm i https://pkg.pr.new/TanStack/router/@tanstack/start-storage-context@5842

@tanstack/valibot-adapter

npm i https://pkg.pr.new/TanStack/router/@tanstack/valibot-adapter@5842

@tanstack/virtual-file-routes

npm i https://pkg.pr.new/TanStack/router/@tanstack/virtual-file-routes@5842

@tanstack/zod-adapter

npm i https://pkg.pr.new/TanStack/router/@tanstack/zod-adapter@5842

commit: 6864270