TanStack / TanStack/cli

[Bug] --router-only main.tsx ignores getRouter() from router.tsx (router.tsx becomes dead code + duplicate Register declaration)

Open
#480 1 comment 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
1.3k
Forks
185
Avg merge
18h 45m
Merged PRs (30d)
2

Description

Which project does this relate to?

Create Tanstack App

Describe the bug

When scaffolding a Router-only SPA (create --router-only), the generated src/router.tsx exports a getRouter() factory, but the generated src/main.tsx does not use it. Instead, main.tsx builds its own router inline with createRouter(...).

As a result:

  1. router.tsx / getRouter() is dead code - nothing imports it anywhere in a --router-only project.
  2. The declare module '@tanstack/react-router' { interface Register { ... } } block is duplicated in both main.tsx (router: typeof router) and router.tsx (router: ReturnType<typeof getRouter>).

In the default (TanStack Start) mode this is fine because Start consumes getRouter() from router.tsx as the entry, and main.tsx is not generated. But in --router-only mode the two files diverge and router.tsx is left orphaned.

Your Example Website or App

pnpx @tanstack/cli create --router-only

Steps to Reproduce the Bug or Issue
  1. pnpx @tanstack/cli create --router-only
  2. Open src/main.tsx and src/router.tsx
  3. Grep the project for getRouter -> only defined in router.tsx, never imported
    (No StackBlitz needed - this is reproducible purely from the CLI output.)
Expected behavior

In --router-only mode, main.tsx should import and use getRouter() from router.tsx, and the Register module augmentation should live in a single place (router.tsx). Something like:

import ReactDOM from 'react-dom/client'
import { RouterProvider } from '@tanstack/react-router'
import { getRouter } from './router'

const router = getRouter()

const rootElement = document.getElementById('app')!

if (!rootElement.innerHTML) {
  const root = ReactDOM.createRoot(rootElement)
  root.render(<RouterProvider router={router} />)
}

This keeps a single source of truth for router configuration across both Start and Router-only modes, removes the dead getRouter(), and removes the duplicate Register declaration.

Screenshots or Videos

No response

Platform
  • OS: macOS
  • @tanstack/cli: 0.69.5
Additional context
  • packages/create/src/frameworks/react/project/base/src/main.tsx.ejs
  • Line 1: <% if (!routerOnly) { ignoreFile() } %> -> only emitted for router-only
  • Lines 6-16: creates its own router + declares Register instead of importing getRouter
  • packages/create/src/frameworks/react/project/base/src/router.tsx.ejs
  • No ignoreFile() guard -> always emitted, exports getRouter() + declares Register

The Solid templates have an identical structure:

  • packages/create/src/frameworks/solid/project/base/src/main.tsx.ejs
  • packages/create/src/frameworks/solid/project/base/src/router.tsx.ejs

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with packages/create/src/frameworks/react/project/base/src/main.tsx.ejs and router.tsx.ejs, then compare the corresponding Solid templates. Run the CLI with --router-only and inspect the generated files; done means main.tsx uses getRouter() and the router configuration and Register declaration are no longer duplicated in the generated project.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
cli, tooling
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Clearly specified
Newbie friendliness
76/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.