cursorrules

{{PROJECT_NAME}} - Cursor Rules

Project Overview

{{PROJECT_DESCRIPTION}}

Architecture: {{ARCHITECTURE_TYPE}} Language: {{PRIMARY_LANGUAGE}} Framework: {{PRIMARY_FRAMEWORK}}

Tech Stack

• Language: {{PRIMARY_LANGUAGE}} ({{LANGUAGE_VERSION}})
• Framework: {{PRIMARY_FRAMEWORK}}
• Database: {{DATABASE}}
• Testing: {{TESTING_FRAMEWORK}}

DO NOT Use

• {{BANNED_DEPENDENCY_1}} (use {{ALTERNATIVE_1}} instead)
• {{BANNED_DEPENDENCY_2}} (use {{ALTERNATIVE_2}} instead)

Core Principles

Clarify Before Coding

Understand requirements before writing code. Ask questions when intent is unclear. No code without clear goals.

Simplicity First

Choose the simplest viable solution. Complex patterns need explicit justification. Readable code over clever code.

Security By Default

Validate all inputs. No secrets in code. Defense in depth. Least privilege principle.

Test-Driven Thinking

Design all code to be testable from inception. Write tests alongside code. Verify before committing.

Code Style

Naming Conventions

• Files: {{FILE_NAMING}} (e.g., kebab-case.tsx, snake_case.py)
• Components: PascalCase
• Functions: camelCase with verb prefixes
• Variables: camelCase, booleans with is/has prefix
• Constants: UPPER_SNAKE_CASE

Readability

Code must be immediately understandable. Use descriptive naming. Maintain clear structure. Readable code over clever code.

Formatting

• Indentation: {{INDENTATION}}
• Line Length: {{LINE_LENGTH}} max
• Quotes: {{QUOTE_STYLE}}
• Semicolons: {{SEMICOLONS}}

Security Rules

• Validate ALL user input with schema validation
• NEVER concatenate SQL strings — use parameterized queries
• NEVER store secrets in source code
• Use environment variables for credentials
• Sanitize HTML before rendering

Testing Standards

• Arrange-Act-Assert pattern
• Descriptive names: "should [behavior] when [condition]"
• Mock external dependencies, not internal logic
• Critical paths: minimum 80% coverage

Workflow

• Atomic changes: small, self-contained modifications
• Conventional commits: type(scope): description
• Only modify files related to current task
• Never add new dependencies without explicit approval or compelling justification
• Use file-scoped commands. Reference docs instead of pasting. Optimize context window usage.
• Follow established conventions for the relevant language and tech stack
• Comment only complex logic or critical functions. Avoid documenting the obvious.
• After generating code, argue against your own solution. Check for redundancy, unnecessary complexity, or simpler alternatives.