Cursor Rules (.cursorrules) Conventions

ai-toolscursorconventions

Best practices for writing .cursorrules files that give Cursor AI precise, useful context to generate accurate, consistent code in your project.

Целевые файлы

Файл	Формат
.cursorrules	plaintext
CLAUDE.md	markdown

Содержимое

# .cursorrules Authoring Rules ## File Purpose - `.cursorrules` provides persistent project context to Cursor's AI — treat it as system instructions, not documentation. - Cursor injects `.cursorrules` into every chat and inline edit session. Every line costs attention — be concise. - Place `.cursorrules` at the project root. Use a single file; avoid fragmentation. ## Opening Context Block - Start with 3-5 sentences: project purpose, primary language and version, framework and version, and critical constraints. - Example: "This is a Node.js 20 REST API using Fastify 4 and TypeScript 5. All routes use Zod for validation. The database is Postgres via Drizzle ORM. Never use `any` type." ## Language & Framework Rules - Specify exact language version where behavior differs (Python 3.12 vs 3.9, TS strict mode on/off). - List the main libraries and their major versions. Cursor will use these when suggesting imports. - Document any library alternatives you have banned: "Use `date-fns`, not `moment` or `dayjs`." ## Code Style Rules - Specify indentation, quote style, and semicolons — even if enforced by a formatter. - Note function style preference: arrow functions vs named functions, class vs functional components. - Specify return type annotation policy: explicit everywhere, inferred for simple functions, etc. ## Naming Conventions - Files: `kebab-case.ts` or `PascalCase.tsx` — be explicit for each file type. - Variables and functions: `camelCase`. Classes and types: `PascalCase`. Constants: `SCREAMING_SNAKE_CASE`. - Database columns and API response keys: `snake_case` (if applicable). - Test files: `*.test.ts` co-located with source, or `__tests__/` directory — specify which. ## Architecture Guidance - Describe folder structure in 5-10 lines with one-liner purposes: `src/routes/` — HTTP handlers only, no business logic. - Specify where business logic lives vs where HTTP/DB logic lives. - Note DI approach: constructor injection, service locator, or plain module imports. ## Error Handling - Specify error strategy: Result types, exceptions, or error callbacks. - Note which error types are domain errors vs infrastructure errors. - Describe the API error response shape. ## Testing Conventions - Specify test runner (Vitest, Jest, pytest) and co-location policy. - Note what must be tested: happy path + error cases for every public function. - Specify mocking approach: `vi.mock`, manual mocks, dependency injection. ## Explicit Prohibitions - Use a "Never do:" section with terse, actionable rules. - Examples: "Never use `console.log` in production code — use the logger.", "Never import from `../..` — use path aliases." - Include security prohibitions: "Never log request bodies containing auth tokens." ## Format Tips - Use plain text, not markdown — Cursor renders raw text, not formatted output. - Keep total length under 200 lines. 100 lines is ideal. - Use ALL CAPS section headers for visual scanning. - Put the highest-priority rules first — Cursor may truncate long files.

CLI

npx mindaxis apply cursor-rules --target cursor --scope project