Skip to content

React + Vite + shadcn + Tailwind rules for AI coding agents

Full stack: React + Vite + Tailwind CSS v4 + shadcn/ui + Zod validation + Vitest

Ready-to-commit rules for React + Vite + Tailwind CSS v4 + shadcn/ui + Zod validation + Vitest in every major format: AGENTS.md (Codex, Cursor, Copilot), CLAUDE.md (Claude Code), Cursor .mdc project rules, legacy .cursorrules, Copilot instructions, Windsurf rules and GEMINI.md. A React + Vite single-page app styled with shadcn/ui components on Tailwind v4, a popular pick for dashboards and admin panels.

Last reviewed 2026-11-04 · Customise in the generator · Raw: AGENTS.md, CLAUDE.md

The mistake agents make most on this stack

Agents rewrite shadcn components from scratch or hand-edit them into one-off variants instead of adding them with the shadcn CLI and composing them.

Generated files

AGENTS.md
# AGENTS.md - this project

Instructions for AI coding agents working in this repository.

## Project

A React + Vite + Tailwind CSS v4 + shadcn/ui + Zod validation + Vitest project.

Stack: React + Vite, Tailwind CSS v4, shadcn/ui, Zod validation, Vitest.

## Commands

- Dev server: `npm run dev`
- Build: `npm run build`
- Type-check: `npx tsc --noEmit`
- Lint: `npm run lint`
- Add a component: `npx shadcn@latest add <component>`
- Unit tests: `npx vitest run`

## Project structure

- Features live in `src/features/<name>/` with their components, hooks and tests together.
- Shared UI in `src/components/`, hooks in `src/hooks/`.

## How to work in this repo

- Read the relevant files before editing. Follow the patterns already in the codebase over these generic rules.
- Make the smallest change that solves the task. Do not refactor or reformat unrelated code.
- Before saying a task is done, run the type-check, lint and tests listed under Commands and fix what you broke.
- If requirements are ambiguous, ask one clear question instead of guessing.
- Never commit secrets, API keys or `.env` files. Use env vars and keep `.env.example` up to date.
- Do not add a new dependency when the standard library or an existing dependency already covers it.
- Ask before adding, removing or upgrading any dependency.
- Ask before changing database schemas, auth, payments or CI configuration.
- Never delete files, drop data or run destructive commands (`rm -rf`, `git push --force`, `DROP TABLE`) without explicit approval.
- Keep each change under ~200 changed lines where possible; split larger work into steps.

## React + Vite

- Function components and hooks only. No class components.
- Follow the Rules of Hooks: call hooks at the top level, never inside conditions or loops.
- Derive values during render instead of syncing them into state with `useEffect`.
- Every list item needs a stable `key` from the data, never the array index if the list can change order.
- Type component props with an exported `Props` type or interface. No `any`.
- Env vars must start with `VITE_` to reach the client, which also means they are public. Never put secrets in them.
- Lazy-load heavy routes with `React.lazy` and `Suspense`.

## Tailwind CSS v4

- Tailwind v4 is configured in CSS: `@import "tailwindcss";` plus `@theme { ... }` for design tokens. Do not create a `tailwind.config.js` unless the project already has one.
- Use theme tokens (colors, spacing) instead of arbitrary values like `w-[37px]`.
- Build responsive layouts mobile-first with `sm:`, `md:`, `lg:` prefixes.
- Extract repeated class lists into components, not `@apply` chains.
- Support dark mode with the `dark:` variant when the project uses it.

## shadcn/ui

- Before building a UI primitive, check whether a shadcn/ui component exists and add it with `npx shadcn@latest add <component>`.
- Components live in `components/ui/` and are owned code: customize them there rather than wrapping them in more layers.
- Merge class names with the `cn()` helper from `lib/utils`.
- Keep accessibility props from Radix (labels, `aria-*`, focus handling) intact.

## Zod validation

- Validate all untrusted input (request bodies, form data, env vars, third-party API responses) with a Zod schema at the boundary.
- Derive TypeScript types from schemas with `z.infer<typeof schema>`; do not hand-write duplicate types.
- Use `safeParse` where you need to return validation errors to the user.

## Vitest

- Co-locate tests next to the code as `*.test.ts(x)`.
- Test behaviour through public APIs; for components use Testing Library queries by role/label.
- Mock network calls at the boundary (e.g. MSW) rather than mocking internal modules.
- Every bug fix adds a test that fails without the fix.

## Avoid

- Do not reach for global state for data that only one component tree uses.

## Reference docs

- [React docs](https://react.dev)
- [Vite docs](https://vite.dev/guide/)
- [Tailwind CSS docs](https://tailwindcss.com/docs)
- [shadcn/ui docs](https://ui.shadcn.com/docs)
- [Zod docs](https://zod.dev)
- [Vitest docs](https://vitest.dev)

Commands your agent should run

TaskCommand
Dev servernpm run dev
Buildnpm run build
Type-checknpx tsc --noEmit
Lintnpm run lint
Add a componentnpx shadcn@latest add <component>
Unit testsnpx vitest run

What the rules cover

React + Vite

Single-page React app built with Vite and TypeScript. Scoped to src/**/*.tsx, src/**/*.ts in Cursor, Copilot and Windsurf.

  • Function components and hooks only. No class components.
  • Follow the Rules of Hooks: call hooks at the top level, never inside conditions or loops.
  • Derive values during render instead of syncing them into state with useEffect.
  • Every list item needs a stable key from the data, never the array index if the list can change order.
  • Type component props with an exported Props type or interface. No any.
  • Env vars must start with VITE_ to reach the client, which also means they are public. Never put secrets in them.
  • Lazy-load heavy routes with React.lazy and Suspense.

Source docs: React docs, Vite docs

Tailwind CSS v4

Utility-first styling with Tailwind CSS v4. Scoped to **/*.css, **/*.tsx, **/*.vue, **/*.svelte, **/*.astro, **/*.html, **/*.blade.php, **/*.erb in Cursor, Copilot and Windsurf.

  • Tailwind v4 is configured in CSS: @import "tailwindcss"; plus @theme { ... } for design tokens. Do not create a tailwind.config.js unless the project already has one.
  • Use theme tokens (colors, spacing) instead of arbitrary values like w-[37px].
  • Build responsive layouts mobile-first with sm:, md:, lg: prefixes.
  • Extract repeated class lists into components, not @apply chains.
  • Support dark mode with the dark: variant when the project uses it.

Source docs: Tailwind CSS docs

shadcn/ui

Copy-in React components built on Radix and Tailwind. Scoped to components/ui/**/*.tsx, src/components/ui/**/*.tsx in Cursor, Copilot and Windsurf.

  • Before building a UI primitive, check whether a shadcn/ui component exists and add it with npx shadcn@latest add <component>.
  • Components live in components/ui/ and are owned code: customize them there rather than wrapping them in more layers.
  • Merge class names with the cn() helper from lib/utils.
  • Keep accessibility props from Radix (labels, aria-*, focus handling) intact.

Source docs: shadcn/ui docs

Zod validation

Runtime schema validation with Zod. Scoped to **/*.ts, **/*.tsx in Cursor, Copilot and Windsurf.

  • Validate all untrusted input (request bodies, form data, env vars, third-party API responses) with a Zod schema at the boundary.
  • Derive TypeScript types from schemas with z.infer<typeof schema>; do not hand-write duplicate types.
  • Use safeParse where you need to return validation errors to the user.

Source docs: Zod docs

Vitest

Unit and component tests with Vitest. Scoped to **/*.test.ts, **/*.test.tsx, **/*.spec.ts in Cursor, Copilot and Windsurf.

  • Co-locate tests next to the code as *.test.ts(x).
  • Test behaviour through public APIs; for components use Testing Library queries by role/label.
  • Mock network calls at the boundary (e.g. MSW) rather than mocking internal modules.
  • Every bug fix adds a test that fails without the fix.

Source docs: Vitest docs

How to install

  1. Copy AGENTS.md to your repo root. That covers Codex, Cursor, GitHub Copilot and most other agents.
  2. Using Claude Code? Add a CLAUDE.md with the single line @AGENTS.md, or use the standalone CLAUDE.md tab above.
  3. Want rules that only load for certain files in Cursor? Add the .cursor/rules/*.mdc files.
  4. Commit the files so your whole team (and every agent) shares them.

FAQ

Where do I put the AGENTS.md for React + Vite + Tailwind CSS v4 + shadcn/ui + Zod validation + Vitest?

Save it as AGENTS.md in the root of your repository, next to your main config file. Codex, Cursor and GitHub Copilot pick it up automatically. For Claude Code, add a CLAUDE.md containing @AGENTS.md (or use the standalone CLAUDE.md on this page).

What is the most common mistake AI agents make with React + Vite?

Agents rewrite shadcn components from scratch or hand-edit them into one-off variants instead of adding them with the shadcn CLI and composing them.

Which commands should the agent run to check its work?

For this stack: npm run dev, npm run build, npx tsc --noEmit, npm run lint. They are listed in the generated files so the agent runs them before finishing a task.

Do these React + Vite + Tailwind CSS v4 + shadcn/ui + Zod validation + Vitest rules work with Cursor and Claude Code?

Yes. This page includes the same rules as AGENTS.md, CLAUDE.md, Cursor .mdc project rules, a legacy .cursorrules file, GitHub Copilot instructions, Windsurf rules and GEMINI.md.

Can I customise these rules?

Yes. Open this stack in the generator to add or remove libraries, set your project name and package manager, switch beginner explanations on, and download everything as a zip.

Related stacks