Skip to content

Commit 142682c

Browse files
committed
feat: add @tanstack/intent AI agent skills for Router and Start
Add SKILL.md files across 11 packages to help AI coding agents generate correct TanStack Router and Start code. Skills cover common patterns, API usage, and failure modes that agents frequently get wrong. Packages with skills: - router-core (10 skills): core concepts, search/path params, navigation, data loading, auth/guards, code splitting, not-found/errors, type safety, SSR - react-router (3): React bindings, Router+Query composition, migration from React Router - start-client-core (6): Start setup, server functions, middleware, execution model, server routes, deployment - react-start (2): React Start bindings, migration from Next.js - virtual-file-routes (1): programmatic route tree building - router-plugin (1): bundler plugin configuration - start-server-core (1): server-side runtime - solid-router (1): Solid bindings - vue-router (1): Vue bindings - solid-start (1): Solid Start bindings - vue-start (1): Vue Start bindings Each package includes bin/intent.js shim, _artifacts/ metadata, and @tanstack/intent devDependency.
1 parent 4ea2a62 commit 142682c

84 files changed

Lines changed: 15141 additions & 27 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎_artifacts/domain_map.yaml‎

Lines changed: 1091 additions & 0 deletions
Large diffs are not rendered by default.

‎_artifacts/skill_spec.md‎

Lines changed: 193 additions & 0 deletions
Large diffs are not rendered by default.

‎_artifacts/skill_tree.yaml‎

Lines changed: 279 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,279 @@
1+
# skills/_artifacts/skill_tree.yaml
2+
library:
3+
name: '@tanstack/router'
4+
version: '1.166.2'
5+
repository: 'https://github.com/TanStack/router'
6+
description: >-
7+
Type-safe router for React and Solid with built-in SWR caching,
8+
JSON-first search params, and end-to-end type inference.
9+
generated_from:
10+
domain_map: '_artifacts/domain_map.yaml'
11+
skill_spec: '_artifacts/skill_spec.md'
12+
generated_at: '2026-03-07'
13+
14+
skills:
15+
# ── Router Core Skills ───────────────────────────────────────────
16+
- name: 'Router Core'
17+
slug: 'router-core'
18+
type: 'core'
19+
domain: 'defining-routes'
20+
path: 'skills/router-core/SKILL.md'
21+
package: 'packages/router-core'
22+
description: >-
23+
Framework-agnostic core concepts for TanStack Router: route trees,
24+
createRouter, createRoute, createRootRoute, createRootRouteWithContext,
25+
addChildren, Register type declaration, route matching, route sorting,
26+
file naming conventions. Entry point for all router skills.
27+
sources:
28+
- 'TanStack/router:docs/router/overview.md'
29+
- 'TanStack/router:docs/router/routing/routing-concepts.md'
30+
- 'TanStack/router:docs/router/routing/route-trees.md'
31+
- 'TanStack/router:docs/router/routing/route-matching.md'
32+
- 'TanStack/router:docs/router/guide/creating-a-router.md'
33+
- 'TanStack/router:docs/router/decisions-on-dx.md'
34+
- 'TanStack/router:packages/router-core/src'
35+
36+
- name: 'Search Params'
37+
slug: 'router-core/search-params'
38+
type: 'sub-skill'
39+
domain: 'managing-url-state'
40+
path: 'skills/router-core/search-params/SKILL.md'
41+
package: 'packages/router-core'
42+
description: >-
43+
validateSearch, search param validation with Zod/Valibot/ArkType adapters,
44+
fallback(), search middlewares (retainSearchParams, stripSearchParams),
45+
custom serialization (parseSearch, stringifySearch), search param
46+
inheritance, loaderDeps for cache keys, reading and writing search params.
47+
requires:
48+
- 'router-core'
49+
sources:
50+
- 'TanStack/router:docs/router/guide/search-params.md'
51+
- 'TanStack/router:docs/router/how-to/setup-basic-search-params.md'
52+
- 'TanStack/router:docs/router/how-to/validate-search-params.md'
53+
- 'TanStack/router:docs/router/how-to/navigate-with-search-params.md'
54+
- 'TanStack/router:docs/router/how-to/share-search-params-across-routes.md'
55+
- 'TanStack/router:docs/router/how-to/arrays-objects-dates-search-params.md'
56+
- 'TanStack/router:docs/router/guide/custom-search-param-serialization.md'
57+
subsystems:
58+
- 'Zod adapter'
59+
- 'Valibot adapter'
60+
- 'ArkType adapter'
61+
references:
62+
- 'references/validation-patterns.md'
63+
64+
- name: 'Path Params'
65+
slug: 'router-core/path-params'
66+
type: 'sub-skill'
67+
domain: 'managing-url-state'
68+
path: 'skills/router-core/path-params/SKILL.md'
69+
package: 'packages/router-core'
70+
description: >-
71+
Dynamic path segments ($paramName), splat routes ($ / _splat),
72+
optional params ({-$paramName}), prefix/suffix patterns ({$param}.ext),
73+
useParams, params.parse/stringify, pathParamsAllowedCharacters,
74+
i18n locale patterns.
75+
requires:
76+
- 'router-core'
77+
sources:
78+
- 'TanStack/router:docs/router/guide/path-params.md'
79+
- 'TanStack/router:docs/router/guide/internationalization-i18n.md'
80+
- 'TanStack/router:docs/router/routing/routing-concepts.md'
81+
82+
- name: 'Navigation'
83+
slug: 'router-core/navigation'
84+
type: 'sub-skill'
85+
domain: 'navigating'
86+
path: 'skills/router-core/navigation/SKILL.md'
87+
package: 'packages/router-core'
88+
description: >-
89+
Link component, useNavigate, Navigate component, router.navigate,
90+
ToOptions/NavigateOptions/LinkOptions, from/to relative navigation,
91+
activeOptions/activeProps, preloading (intent/viewport/render),
92+
preloadDelay, navigation blocking (useBlocker, Block), createLink,
93+
linkOptions helper, scroll restoration, MatchRoute.
94+
requires:
95+
- 'router-core'
96+
sources:
97+
- 'TanStack/router:docs/router/guide/navigation.md'
98+
- 'TanStack/router:docs/router/guide/preloading.md'
99+
- 'TanStack/router:docs/router/guide/navigation-blocking.md'
100+
- 'TanStack/router:docs/router/guide/link-options.md'
101+
- 'TanStack/router:docs/router/guide/custom-link.md'
102+
- 'TanStack/router:docs/router/guide/scroll-restoration.md'
103+
104+
- name: 'Data Loading'
105+
slug: 'router-core/data-loading'
106+
type: 'sub-skill'
107+
domain: 'loading-data'
108+
path: 'skills/router-core/data-loading/SKILL.md'
109+
package: 'packages/router-core'
110+
description: >-
111+
Route loader option, loaderDeps for cache keys, staleTime/gcTime/
112+
defaultPreloadStaleTime SWR caching, pendingComponent/pendingMs/
113+
pendingMinMs, errorComponent/onError/onCatch, beforeLoad, router
114+
context and createRootRouteWithContext DI pattern, router.invalidate,
115+
Await component, deferred data loading with unawaited promises.
116+
requires:
117+
- 'router-core'
118+
sources:
119+
- 'TanStack/router:docs/router/guide/data-loading.md'
120+
- 'TanStack/router:docs/router/guide/deferred-data-loading.md'
121+
- 'TanStack/router:docs/router/guide/router-context.md'
122+
- 'TanStack/router:docs/router/guide/data-mutations.md'
123+
124+
- name: 'Auth and Guards'
125+
slug: 'router-core/auth-and-guards'
126+
type: 'sub-skill'
127+
domain: 'protecting-routes'
128+
path: 'skills/router-core/auth-and-guards/SKILL.md'
129+
package: 'packages/router-core'
130+
description: >-
131+
Route protection with beforeLoad, redirect()/throw redirect(),
132+
isRedirect helper, authenticated layout routes (_authenticated),
133+
non-redirect auth (inline login), RBAC with roles and permissions,
134+
auth provider integration (Auth0, Clerk, Supabase), router context
135+
for auth state.
136+
requires:
137+
- 'router-core'
138+
- 'router-core/data-loading'
139+
sources:
140+
- 'TanStack/router:docs/router/guide/authenticated-routes.md'
141+
- 'TanStack/router:docs/router/how-to/setup-authentication.md'
142+
- 'TanStack/router:docs/router/how-to/setup-auth-providers.md'
143+
- 'TanStack/router:docs/router/how-to/setup-rbac.md'
144+
145+
- name: 'Code Splitting'
146+
slug: 'router-core/code-splitting'
147+
type: 'sub-skill'
148+
domain: 'rendering-and-layout'
149+
path: 'skills/router-core/code-splitting/SKILL.md'
150+
package: 'packages/router-core'
151+
description: >-
152+
Automatic code splitting (autoCodeSplitting), .lazy.tsx convention,
153+
createLazyFileRoute, createLazyRoute, lazyRouteComponent, getRouteApi
154+
for typed hooks in split files, codeSplitGroupings per-route override,
155+
splitBehavior programmatic config, critical vs non-critical properties.
156+
requires:
157+
- 'router-core'
158+
sources:
159+
- 'TanStack/router:docs/router/guide/code-splitting.md'
160+
- 'TanStack/router:docs/router/guide/automatic-code-splitting.md'
161+
162+
- name: 'Not Found and Errors'
163+
slug: 'router-core/not-found-and-errors'
164+
type: 'sub-skill'
165+
domain: 'rendering-and-layout'
166+
path: 'skills/router-core/not-found-and-errors/SKILL.md'
167+
package: 'packages/router-core'
168+
description: >-
169+
notFound() function, notFoundComponent, defaultNotFoundComponent,
170+
notFoundMode (fuzzy/root), errorComponent, onError/onCatch,
171+
CatchBoundary, NotFoundRoute (deprecated), route masking (mask
172+
option, createRouteMask, unmaskOnReload).
173+
requires:
174+
- 'router-core'
175+
sources:
176+
- 'TanStack/router:docs/router/guide/not-found-errors.md'
177+
- 'TanStack/router:docs/router/guide/route-masking.md'
178+
179+
- name: 'Type Safety'
180+
slug: 'router-core/type-safety'
181+
type: 'sub-skill'
182+
domain: 'type-safety'
183+
path: 'skills/router-core/type-safety/SKILL.md'
184+
package: 'packages/router-core'
185+
description: >-
186+
Full type inference philosophy (never cast, never annotate inferred
187+
values), Register module declaration, from narrowing on hooks and
188+
Link, strict:false for shared components, getRouteApi for code-split
189+
typed access, addChildren with object syntax for TS perf, LinkProps
190+
and ValidateLinkOptions type utilities, as const satisfies pattern.
191+
requires:
192+
- 'router-core'
193+
sources:
194+
- 'TanStack/router:docs/router/guide/type-safety.md'
195+
- 'TanStack/router:docs/router/guide/type-utilities.md'
196+
- 'TanStack/router:docs/router/guide/render-optimizations.md'
197+
198+
- name: 'SSR'
199+
slug: 'router-core/ssr'
200+
type: 'sub-skill'
201+
domain: 'server-side-rendering'
202+
path: 'skills/router-core/ssr/SKILL.md'
203+
package: 'packages/router-core'
204+
description: >-
205+
Non-streaming and streaming SSR, RouterClient/RouterServer,
206+
renderRouterToString/renderRouterToStream, createRequestHandler,
207+
defaultRenderHandler/defaultStreamHandler, HeadContent/Scripts
208+
components, head route option (meta/links/styles/scripts),
209+
ScriptOnce, automatic loader dehydration/hydration, memory
210+
history on server, data serialization, document head management.
211+
requires:
212+
- 'router-core'
213+
- 'router-core/data-loading'
214+
sources:
215+
- 'TanStack/router:docs/router/guide/ssr.md'
216+
- 'TanStack/router:docs/router/guide/document-head-management.md'
217+
- 'TanStack/router:docs/router/how-to/setup-ssr.md'
218+
219+
# ── React Router Skills ──────────────────────────────────────────
220+
- name: 'React Router'
221+
slug: 'react-router'
222+
type: 'framework'
223+
domain: 'defining-routes'
224+
path: 'skills/react-router/SKILL.md'
225+
package: 'packages/react-router'
226+
description: >-
227+
React bindings for TanStack Router: RouterProvider, useRouter,
228+
useRouterState, useMatch, useMatches, useLocation, useSearch,
229+
useParams, useNavigate, useLoaderData, useLoaderDeps,
230+
useRouteContext, useBlocker, useCanGoBack, Link, Navigate,
231+
Outlet, CatchBoundary, ErrorComponent. React-specific patterns
232+
for hooks, providers, SSR hydration, and createLink with
233+
forwardRef.
234+
requires:
235+
- 'router-core'
236+
sources:
237+
- 'TanStack/router:packages/react-router/src'
238+
- 'TanStack/router:docs/router/guide/creating-a-router.md'
239+
- 'TanStack/router:docs/router/installation/manual.md'
240+
241+
# ── Composition Skills ───────────────────────────────────────────
242+
- name: 'External Data Loading (TanStack Query)'
243+
slug: 'compositions/router-query'
244+
type: 'composition'
245+
domain: 'loading-data'
246+
path: 'skills/compositions/router-query/SKILL.md'
247+
package: 'packages/react-router'
248+
description: >-
249+
Integrating TanStack Router with TanStack Query: queryClient
250+
in router context, ensureQueryData/prefetchQuery in loaders,
251+
useSuspenseQuery in components, defaultPreloadStaleTime: 0,
252+
setupRouterSsrQueryIntegration for SSR dehydration/hydration
253+
and streaming, per-request QueryClient isolation.
254+
requires:
255+
- 'router-core'
256+
- 'router-core/data-loading'
257+
- 'react-router'
258+
sources:
259+
- 'TanStack/router:docs/router/guide/external-data-loading.md'
260+
- 'TanStack/router:docs/router/integrations/query.md'
261+
262+
# ── Lifecycle Skills ─────────────────────────────────────────────
263+
- name: 'Migrate from React Router'
264+
slug: 'lifecycle/migrate-from-react-router'
265+
type: 'lifecycle'
266+
domain: 'defining-routes'
267+
path: 'skills/lifecycle/migrate-from-react-router/SKILL.md'
268+
package: 'packages/react-router'
269+
description: >-
270+
Step-by-step migration from React Router v7 to TanStack Router:
271+
route definition conversion, Link/useNavigate API differences,
272+
useSearchParams to validateSearch + useSearch, useParams with from,
273+
Outlet replacement, loader conversion, code splitting differences.
274+
requires:
275+
- 'router-core'
276+
- 'react-router'
277+
sources:
278+
- 'TanStack/router:docs/router/how-to/migrate-from-react-router.md'
279+
- 'TanStack/router:docs/router/installation/migrate-from-react-router.md'

0 commit comments

Comments
 (0)