π¨π»βπ»π©π»βπ» Use Ant Design like a Pro!
# CLAUDE.md
## Project
Ant Design Pro β React enterprise boilerplate on Umi Max v4, antd v6, ProComponents v3.
## Commands
`npm start` (dev+mock), `npm run dev` (no mock), `npm run build` (utoopack), `npm run lint` (Biome+tsc), `npm run test` (Jest), `npx antd lint ./src` (antd-specific checks).
Other: `npm run openapi` (regenerate `src/services/`), `npm run simple` (**irreversible** β commit first), `npm run biome` (auto-fix), `npm run tsc` (type-check only).
## Critical Rules
- **Never edit `src/services/ant-design-pro/`** β auto-generated, regenerate with `npm run openapi`
- **Biome only** β no ESLint, no Prettier. Both `npm run lint` and `npx antd lint ./src` must pass before commit
- **Always `npx antd info <Component>` before writing antd code** β don't guess APIs from memory
- **`npm run simple` is irreversible** β always commit/branch first
- **Conventional commits** required (commitlint enforced)
- **TypeScript strict** Β· **Node β₯ 22** Β· **`package-lock.json`** (not yarn/pnpm)
- **`.umi` dir is auto-generated** β delete `src/.umi` and restart if dev server acts up
## Architecture Essentials
**Config**: `config/config.ts` (defineConfig), `config/routes.ts` (declarative routes). Route `name` β `menu.xxx` i18n key; `access` field gates visibility.
**Convention files** (`src/`): `app.tsx` (runtime config + `getInitialState`), `access.ts` (permissions), `global.tsx` (side effects), `loading.tsx`, `typings.d.ts`.
**Auth**: `getInitialState()` β `GET /api/currentUser`; 401 β redirect login. `access.ts`: `canAdmin = currentUser.access === 'admin'`. Mock creds: `admin`/`ant.design` or `user`/`ant.design`.
**State**: `useModel('filename')` for global hooks (`src/models/`). `useModel('@@initialState')` for currentUser/settings. ProTable `request` prop for most data loading. `@tanstack/react-query` for complex server state.
**Styling priority**: Tailwind CSS v4 (layout) β antd-style v4 / `createStyles` (theme tokens) β CSS Modules β Less (legacy only).
**Request**: built-in `request` from `@umijs/max`, configured in `src/requestErrorConfig.ts`. Per-page `service.ts` for non-generated APIs.
**i18n**: 8 locales in `src/locales/`. `useIntl().formatMessage({ id, defaultMessage })`.
**Mock**: `mock/` (global) + `src/pages/**/_mock.ts` (co-located). Express-style handlers.
**Cloudflare Worker**: `cloudflare-worker/` β separate Hono app, own `package.json`, not an npm workspace.
## AI Skills
This project ships with two built-in Claude Code Skills (`.claude/skills/`). If you already have these skills in your project, no installation is needed β just run them directly. To update to the latest skill definitions, run `npx skills add ant-design/ant-design-pro`.
### `/pro-upgrade` β Project Upgrade
Run `/pro-upgrade` in Claude Code to auto-upgrade the project to the latest Ant Design Pro version. It diffs the latest template against this project and merges framework changes while preserving business code. Works for any version gap (v5βv6, v6.xβlatest, etc.).
### `/antd` β Ant Design CLI
Run `/antd` in Claude Code for any antd-related work. It provides access to `@ant-design/cli` with offline metadata for antd v3/v4/v5/v6. Key commands:
- `npx antd info <Component>` β look up props/API before writing code (mandatory)
- `npx antd lint ./src` β check for deprecated or problematic usage (must pass before commit)
- `npx antd demo <Component> <demo>` β get working code examples
- `npx antd migrate <from> <to>` β migration checklist between major versions
## Page Co-location
Each page dir: `index.tsx`, optional `service.ts`, `_mock.ts`, `data.d.ts`, style files. Keep page-specific code with the page.
# CLAUDE.md
Behavioral guidelines to reduce common LLM coding mistakes. Merge with project-specific instructions as needed.
**Tradeoff:** These guidelines bias toward caution over speed. For trivial tasks, use judgment.
## 1. Think Before Coding
**Don't assume. Don't hide confusion. Surface tradeoffs.**
Before implementing:
- State your assumptions explicitly. If uncertain, ask.
- If multiple interpretations exist, present them - don't pick silently.
- If a simpler approach exists, say so. Push back when warranted.
- If something is unclear, stop. Name what's confusing. Ask.
## 2. Simplicity First
**Minimum code that solves the problem. Nothing speculative.**
- No features beyond what was asked.
- No abstractions for single-use code.
- No "flexibility" or "configurability" that wasn't requested.
- No error handling for impossible scenarios.
- If you write 200 lines and it could be 50, rewrite it.
Ask yourself: "Would a senior engineer say this is overcomplicated?" If yes, simplify.
## 3. Surgical Changes
**Touch only what you must. Clean up only your own mess.**
When editing existing code:
- Don't "improve" adjacent code, comments, or formatting.
- Don't refactor things that aren't broken.
- Match existing style, even if you'd do it differently.
- If you notice unrelated dead code, mention it - don't delete it.
When your changes create orphans:
- Remove imports/variables/functions that YOUR changes made unused.
- Don't remove pre-existing dead code unless asked.
The test: Every changed line should trace directly to the user's request.
## 4. Goal-Driven Execution
**Define success criteria. Loop until verified.**
Transform tasks into verifiable goals:
- "Add validation" β "Write tests for invalid inputs, then make them pass"
- "Fix the bug" β "Write a test that reproduces it, then make it pass"
- "Refactor X" β "Ensure tests pass before and after"
For multi-step tasks, state a brief plan:
```
1. [Step] β verify: [check]
2. [Step] β verify: [check]
3. [Step] β verify: [check]
```
Strong success criteria let you loop independently. Weak criteria ("make it work") require constant clarification.
---
**These guidelines are working if:** fewer unnecessary changes in diffs, fewer rewrites due to overcomplication, and clarifying questions come before implementation rather than after mistakes.
---