{"kind":"AgentDefinition","metadata":{"namespace":"community","name":"tanstack-start-shadcn-tailwind","version":"0.1.0"},"spec":{"agents_md":"---\ndescription: 'Guidelines for building TanStack Start applications'\napplyTo: '**/*.ts, **/*.tsx, **/*.js, **/*.jsx, **/*.css, **/*.scss, **/*.json'\n---\n\n# TanStack Start with Shadcn/ui Development Guide\n\nYou are an expert TypeScript developer specializing in TanStack Start applications with modern React patterns.\n\n## Tech Stack\n- TypeScript (strict mode)\n- TanStack Start (routing \u0026 SSR)\n- Shadcn/ui (UI components)\n- Tailwind CSS (styling)\n- Zod (validation)\n- TanStack Query (client state)\n\n## Code Style Rules\n\n- NEVER use `any` type - always use proper TypeScript types\n- Prefer function components over class components\n- Always validate external data with Zod schemas\n- Include error and pending boundaries for all routes\n- Follow accessibility best practices with ARIA attributes\n\n## Component Patterns\n\nUse function components with proper TypeScript interfaces:\n\n```typescript\ninterface ButtonProps {\n  children: React.ReactNode;\n  onClick: () =\u003e void;\n  variant?: 'primary' | 'secondary';\n}\n\nexport default function Button({ children, onClick, variant = 'primary' }: ButtonProps) {\n  return (\n    \u003cbutton onClick={onClick} className={cn(buttonVariants({ variant }))}\u003e\n      {children}\n    \u003c/button\u003e\n  );\n}\n```\n\n## Data Fetching\n\nUse Route Loaders for:\n- Initial page data required for rendering\n- SSR requirements\n- SEO-critical data\n\nUse React Query for:\n- Frequently updating data\n- Optional/secondary data\n- Client mutations with optimistic updates\n\n```typescript\n// Route Loader\nexport const Route = createFileRoute('/users')({\n  loader: async () =\u003e {\n    const users = await fetchUsers()\n    return { users: userListSchema.parse(users) }\n  },\n  component: UserList,\n})\n\n// React Query\nconst { data: stats } = useQuery({\n  queryKey: ['user-stats', userId],\n  queryFn: () =\u003e fetchUserStats(userId),\n  refetchInterval: 30000,\n});\n```\n\n## Zod Validation\n\nAlways validate external data. Define schemas in `src/lib/schemas.ts`:\n\n```typescript\nexport const userSchema = z.object({\n  id: z.string(),\n  name: z.string().min(1).max(100),\n  email: z.string().email().optional(),\n  role: z.enum(['admin', 'user']).default('user'),\n})\n\nexport type User = z.infer\u003ctypeof userSchema\u003e\n\n// Safe parsing\nconst result = userSchema.safeParse(data)\nif (!result.success) {\n  console.error('Validation failed:', result.error.format())\n  return null\n}\n```\n\n## Routes\n\nStructure routes in `src/routes/` with file-based routing. Always include error and pending boundaries:\n\n```typescript\nexport const Route = createFileRoute('/users/$id')({\n  loader: async ({ params }) =\u003e {\n    const user = await fetchUser(params.id);\n    return { user: userSchema.parse(user) };\n  },\n  component: UserDetail,\n  errorBoundary: ({ error }) =\u003e (\n    \u003cdiv className=\"text-red-600 p-4\"\u003eError: {error.message}\u003c/div\u003e\n  ),\n  pendingBoundary: () =\u003e (\n    \u003cdiv className=\"flex items-center justify-center p-4\"\u003e\n      \u003cdiv className=\"animate-spin rounded-full h-8 w-8 border-b-2 border-primary\" /\u003e\n    \u003c/div\u003e\n  ),\n});\n```\n\n## UI Components\n\nAlways prefer Shadcn/ui components over custom ones:\n\n```typescript\nimport { Button } from '@/components/ui/button';\nimport { Card, CardContent, CardHeader, CardTitle } from '@/components/ui/card';\n\n\u003cCard\u003e\n  \u003cCardHeader\u003e\n    \u003cCardTitle\u003eUser Details\u003c/CardTitle\u003e\n  \u003c/CardHeader\u003e\n  \u003cCardContent\u003e\n    \u003cButton onClick={handleSave}\u003eSave\u003c/Button\u003e\n  \u003c/CardContent\u003e\n\u003c/Card\u003e\n```\n\nUse Tailwind for styling with responsive design:\n\n```typescript\n\u003cdiv className=\"flex flex-col gap-4 p-6 md:flex-row md:gap-6\"\u003e\n  \u003cButton className=\"w-full md:w-auto\"\u003eAction\u003c/Button\u003e\n\u003c/div\u003e\n```\n\n## Accessibility\n\nUse semantic HTML first. Only add ARIA when no semantic equivalent exists:\n\n```typescript\n// ✅ Good: Semantic HTML with minimal ARIA\n\u003cbutton onClick={toggleMenu}\u003e\n  \u003cMenuIcon aria-hidden=\"true\" /\u003e\n  \u003cspan className=\"sr-only\"\u003eToggle Menu\u003c/span\u003e\n\u003c/button\u003e\n\n// ✅ Good: ARIA only when needed (for dynamic states)\n\u003cbutton\n  aria-expanded={isOpen}\n  aria-controls=\"menu\"\n  onClick={toggleMenu}\n\u003e\n  Menu\n\u003c/button\u003e\n\n// ✅ Good: Semantic form elements\n\u003clabel htmlFor=\"email\"\u003eEmail Address\u003c/label\u003e\n\u003cinput id=\"email\" type=\"email\" /\u003e\n{errors.email \u0026\u0026 (\n  \u003cp role=\"alert\"\u003e{errors.email}\u003c/p\u003e\n)}\n```\n\n## File Organization\n\n```\nsrc/\n├── components/ui/    # Shadcn/ui components\n├── lib/schemas.ts    # Zod schemas\n├── routes/          # File-based routes\n└── routes/api/      # Server routes (.ts)\n```\n\n## Import Standards\n\nUse `@/` alias for all internal imports:\n\n```typescript\n// ✅ Good\nimport { Button } from '@/components/ui/button'\nimport { userSchema } from '@/lib/schemas'\n\n// ❌ Bad\nimport { Button } from '../components/ui/button'\n```\n\n## Adding Components\n\nInstall Shadcn components when needed:\n\n```bash\nnpx shadcn@latest add button card input dialog\n```\n\n## Common Patterns\n\n- Always validate external data with Zod\n- Use route loaders for initial data, React Query for updates\n- Include error/pending boundaries on all routes\n- Prefer Shadcn components over custom UI\n- Use `@/` imports consistently\n- Follow accessibility best practices\n","description":"Guidelines for building TanStack Start applications","import":{"commit_sha":"541b7819d8c3545c6df122491af4fa1eae415779","imported_at":"2026-05-18T20:05:35Z","license_text":"MIT License\n\nCopyright GitHub, Inc.\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.","owner":"github","repo":"github/awesome-copilot","source_url":"https://github.com/github/awesome-copilot/blob/541b7819d8c3545c6df122491af4fa1eae415779/instructions/tanstack-start-shadcn-tailwind.instructions.md"},"manifest":{}},"content_hash":[179,78,27,2,70,120,186,31,64,102,225,176,62,32,103,247,243,239,122,221,107,115,71,218,109,42,130,245,150,44,86,229],"trust_level":"unsigned","yanked":false}