virtual-file-routes — скилл для Claude Code
Скилл virtual-file-routes для Claude Code строит деревья маршрутов программно как альтернативу файловым соглашениям. Запускается при правке конфигурации маршрутизатора в проекте.
MIT 108 установок ★ 15 341 обновлён 2026-10-25
npx skills add TanStack/router --skill virtual-file-routes -a claude-codeЧто делает virtual-file-routes
Скилл собирает маршруты через функции корневых узлов, индексов, путей, макетов и поддеревьев. Пути файлов задаются относительно директории маршрутов. Поддерживается вставка поддиректорий файлового роутинга.
Типы выводятся автоматически. Категорически запрещено использовать принудительное приведение типов.
Перед запуском требуется установить пакет @tanstack/virtual-file-routes через npm и передать конфигурацию в плагин роутера.
Какие задачи решает
- собрать дерево маршрутов программно через корневой узел и индекс
- смонтировать директорию файловых маршрутов с префиксом пути
- создать макет без добавления сегмента в URL
- определить поддерево в конфигурации маршрутизации
Примеры запросов агенту
- Собери дерево маршрутов через
rootRouteи добавь индексный маршрут - Добавь физическое монтирование папки через
physical - Настрой конфигурацию виртуального поддерева через
defineVirtualSubtreeConfig
Как установить virtual-file-routes
1Через Skills CLI (Vercel)
npx skills add TanStack/router --skill virtual-file-routes -a claude-code2Вручную: положить файлы
~/.claude/skills/virtual-file-routes/SKILL.mdПапка скилла целиком; для одного проекта — .claude/skills/virtual-file-routes/
1Через Skills CLI (Vercel)
npx skills add TanStack/router --skill virtual-file-routes -a codex2Вручную: положить файлы
.agents/skills/virtual-file-routes/SKILL.mdДля всех проектов — ~/.agents/skills/
1Через Skills CLI (Vercel)
npx skills add TanStack/router --skill virtual-file-routes -a cursor2Вручную: положить файлы
.cursor/skills/virtual-file-routes/SKILL.mdCursor читает и .agents/skills/, и .claude/skills/
1GitHub CLI
gh skill install TanStack/router packages/virtual-file-routes/skills/virtual-file-routes2Вручную: положить файлы
.github/skills/virtual-file-routes/SKILL.md1Через Skills CLI (Vercel)
npx skills add TanStack/router --skill virtual-file-routes -a gemini-cli2Командой платформы
gemini skills install https://github.com/TanStack/router --path packages/virtual-file-routes/skills/virtual-file-routesВручную: положить файлы
.devin/skills/virtual-file-routes/SKILL.mdСтарый путь .windsurf/skills/ тоже читается
Через Skills CLI (Vercel)
npx skills add TanStack/router --skill virtual-file-routes -a opencodeClaude.ai
Упакуйте папку в zip и загрузите в Settings → Capabilities → Skills
По шагам, с командами для каждой платформы: Как установить скилл в Claude Code: пять способов
Вопросы о virtual-file-routes
Как установить virtual-file-routes в Claude Code?
Выполните команды npx skills add TanStack/router --skill virtual-file-routes -a claude-code и обратитесь к файлу ~/.claude/skills/virtual-file-routes/SKILL.md.
Что делает virtual-file-routes?
Строит деревья маршрутов программным способом без жёсткой привязки к файловой структуре.
Что нужно для работы virtual-file-routes?
Установленный пакет @tanstack/virtual-file-routes и плагин TanStack Router в конфигурации сборщика.
Исходный текст
SKILL.md · MIT
---
name: virtual-file-routes
description: >-
Programmatic route tree building as an alternative to filesystem
conventions: rootRoute, index, route, layout, physical,
defineVirtualSubtreeConfig. Use with TanStack Router plugin's
virtualRouteConfig option.
metadata:
type: core
library: tanstack-router
library_version: '1.162.0'
sources:
- TanStack/router:packages/virtual-file-routes/src
- TanStack/router:docs/router/routing/virtual-file-routes.md
---
# Virtual File Routes (`@tanstack/virtual-file-routes`)
Build route trees programmatically instead of relying on filesystem conventions. Useful when you want explicit control over route structure, need to mix virtual and physical routes, or want to define route subtrees within file-based routing directories.
Use this skill only when the project config contains `virtualRouteConfig`, a virtual route config file, or `__virtual.ts`. Ordinary file-route changes belong to Router Core and the Router Plugin.
> **CRITICAL**: Types are FULLY INFERRED. Never cast, never annotate inferred values.
## Install
```bash
npm install @tanstack/virtual-file-routes
```
## API Reference
### `rootRoute(file, children?)`
Creates the root of a virtual route tree.
```ts
import { rootRoute, index, route } from '@tanstack/virtual-file-routes'
const routes = rootRoute('root.tsx', [
index('index.tsx'),
route('/about', 'about.tsx'),
])
```
### `index(file)`
Creates an index route — the default rendered when the parent path matches exactly.
```ts
import { index } from '@tanstack/virtual-file-routes'
index('home.tsx')
```
### `route(path, ...)`
Creates a route node. Three call signatures:
```ts
import { route, index } from '@tanstack/virtual-file-routes'
// Leaf route: path + file
route('/about', 'about.tsx')
// Branch route: path + file + children
route('/dashboard', 'dashboard.tsx', [
index('dashboard-index.tsx'),
route('/settings', 'settings.tsx'),
])
// Path prefix only (no file): groups children under a URL segment
route('/api', [route('/users', 'users.tsx'), route('/posts', 'posts.tsx')])
```
### `layout(file, children)` or `layout(id, file, children)`
Creates a pathless layout route — wraps children without adding a URL segment.
```ts
import { layout, route, index } from '@tanstack/virtual-file-routes'
// ID derived from filename
layout('authLayout.tsx', [
route('/dashboard', 'dashboard.tsx'),
route('/settings', 'settings.tsx'),
])
// Explicit ID
layout('admin-layout', 'adminLayout.tsx', [route('/admin', 'admin.tsx')])
```
### `physical(pathPrefix, directory)` or `physical(directory)`
Mounts a directory of file-based routes at a URL prefix. Uses TanStack Router's standard file-based routing conventions within that directory.
```ts
import { physical } from '@tanstack/virtual-file-routes'
// Mount posts/ directory under /posts
physical('/posts', 'posts')
// Merge features/ directory at the current level
physical('features')
```
### `defineVirtualSubtreeConfig(config)`
Type helper for `__virtual.ts` files inside file-based routing directories. Identity function that provides type inference.
```ts
// src/routes/admin/__virtual.ts
import {
defineVirtualSubtreeConfig,
index,
route,
} from '@tanstack/virtual-file-routes'
export default defineVirtualSubtreeConfig([
index('home.tsx'),
route('$id', 'details.tsx'),
])
```
## Integration with Router Plugin
Pass the virtual route config to the TanStack Router plugin:
```ts
// vite.config.ts
import { defineConfig } from 'vite'
import { tanstackRouter } from '@tanstack/router-plugin/vite'
import { routes } from './routes'
export default defineConfig({
plugins: [
tanstackRouter({
target: 'react', // or 'solid', 'vue'
virtualRouteConfig: routes,
}),
// Add your framework's Vite plugin here
],
})
```
Or reference a file path:
```ts
tanstackRouter({
target: 'react',
virtualRouteConfig: './routes.ts',
})
```
## Full Example
```ts
// routes.ts
import {
rootRoute,
route,
index,
layout,
physical,
} from '@tanstack/virtual-file-routes'
export const routes = rootRoute('root.tsx', [
index('index.tsx'),
layout('authLayout.tsx', [
route('/dashboard', 'app/dashboard.tsx', [
index('app/dashboard-index.tsx'),
route('/invoices', 'app/dashboard-invoices.tsx', [
index('app/invoices-index.tsx'),
route('$id', 'app/invoice-detail.tsx'),
]),
]),
]),
// Mount file-based routing from posts/ directory
physical('/posts', 'posts'),
])
```
## Common Mistakes
### 1. HIGH: Forgetting that file paths are relative to routesDirectory
File paths in `rootRoute`, `index`, `route`, and `layout` are relative to the `routesDirectory` configured in the router plugin (default: `./src/routes`). Do not use absolute paths or paths relative to the project root.
```ts
// WRONG — absolute path
route('/about', '/src/routes/about.tsx')
// CORRECT — relative to routesDirectory
route('/about', 'about.tsx')
```
### 2. MEDIUM: Using physical() without matching directory structure
The directory passed to `physical()` must exist inside `routesDirectory` and follow TanStack Router's file-based routing conventions.
```ts
// WRONG — directory doesn't exist or wrong location
physical('/blog', 'src/blog')
// CORRECT — relative to routesDirectory
physical('/blog', 'blog')
// Expects: src/routes/blog/ (with route files inside)
```
### 3. MEDIUM: Confusing layout() with route()
`layout()` creates a pathless wrapper — it does NOT add a URL segment. Use `route()` for URL segments.
```ts
// This does NOT create a /dashboard URL
layout('dashboardLayout.tsx', [route('/dashboard', 'dashboard.tsx')])
// The URL is /dashboard, and dashboardLayout.tsx wraps it
```
## Refactor Audit
After changing a virtual tree:
1. Confirm there is exactly one `rootRoute` and that every referenced file exists relative to `routesDirectory`.
2. Check each `route`, `layout`, and `physical` node for duplicate effective paths or IDs.
3. Confirm each `physical()` directory is mounted once at the intended path prefix and does not overlap a virtual child.
4. Regenerate `routeTree.gen.ts` and inspect parentage, full paths, and imports. Do not edit generated output.
5. Update links, redirects, params, and `from` narrowing, then run generator tests, type tests, and a production build.
© TanStack · MIT · TanStack/router