AGENTS.md

1# Frontend Guidelines
2 
3`ui/` is the Vue 3 + TypeScript + TailwindCSS frontend, managed with pnpm workspaces.
4 
5## Structure
6 
7- `ui/src/` — console application.
8- `ui/uc-src/` — user center application.
9- `ui/packages/` — shared workspace packages (`@halo-dev/api-client`, `@halo-dev/components`, `@halo-dev/console-shared`, `@halo-dev/editor`, `@halo-dev/shared`, `@halo-dev/ui-plugin-bundler-kit`).
10- Unit tests: `*.spec.ts` files, usually under `__tests__/` next to the code they cover.
11 
12## Commands
13 
14Run from the repo root:
15 
16- `pnpm -C ui install` / `pnpm -C ui dev` — install dependencies / run the dev server.
17- `pnpm -C ui build` — production build.
18- `pnpm -C ui typecheck` — `vue-tsc` type checking.
19- `pnpm -C ui lint` — ESLint (fails on any warning).
20- `pnpm -C ui format` / `pnpm -C ui format:check` — Prettier formatting.
21- `pnpm -C ui test:unit` — Vitest unit tests.
22- `./gradlew generateOpenApiDocs && pnpm -C ui api-client:gen` — regenerate `ui/packages/api-client` after backend contract changes.
23 
24## Conventions
25 
26- Follow existing component and composable patterns; match surrounding code rather than introducing new stylistic islands.
27- Never hand-edit `ui/packages/api-client/src/` — it is generated; regenerate it instead.
28- Keep dependency versions in `ui/package.json`; never hard-code versions.
29- Payload or UX changes usually ship together with the backend change that defines the contract.
30 
31## Boundaries
32 
33- New npm dependencies require approval.
34