setup-tanstack-router

What problem does it solve?

Automatically enforce TanStack Router usage patterns and prevent common routing mistakes by auto-generating and validating route trees during development.

Core Features & Use Cases

• Ban react-router-dom imports within route files to promote TanStack Router usage.
• Block window.location navigation and hard reloads, guiding developers toward router-based navigation and invalidate/query-based approaches.
• Auto-regenerate the route tree on route file changes to maintain routing accuracy and reduce manual sync.
• Enforce typed route params with explicit from-based references and require validateSearch where useSearch is used.
• Guard against anti-patterns like strict: false and untyped hooks, and encourage type-safe, component-scoped routing.

Quick Start

Configure your project to manage routes with TanStack Router and enable the auto-generation hooks to keep the route tree up to date.