diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 0000000..f0af1a6 --- /dev/null +++ b/AGENTS.md @@ -0,0 +1,158 @@ +# Nova Admin - Agent Coding Guidelines + +This document provides guidelines for agentic coding agents working on this codebase. + +## Build, Lint & Test Commands + +```bash +# Development +pnpm dev # Start dev server (uses vite --mode dev) +pnpm dev:prod # Start with production config + +# Build +pnpm build # Production build +pnpm preview # Preview production build + +# Linting +pnpm lint # Run eslint + vue-tsc type check +pnpm lint:fix # Auto-fix eslint issues +pnpm lint:check # Inspect eslint configuration +pnpm sizecheck # Visualize bundle size + +# Pre-commit hook +# Automatically runs pnpm lint-staged (eslint --fix) on commit +``` + +## Code Style Guidelines + +### Imports +- No strict import sorting enforced (eslint `perfectionist/sort-imports` is OFF) +- Imports use `@/` alias for `src/` directory (e.g., `@/api`, `@/store`, `@/hooks`) +- Third-party and local imports are mixed; follow the pattern in existing files +- Auto-imports are enabled via `unplugin-auto-import` for Vue APIs + +### Formatting & Structure +- **Vue components**: Use `