Cursor rule

1---
2description: Guidelines for creating and maintaining Cursor rules to ensure consistency and effectiveness.
3globs: .cursor/rules/*.mdc
4alwaysApply: true
5---
6 
7- **Required Rule Structure:**
8```markdown
9  ---
10  description: Clear, one-line description of what the rule enforces
11  globs: path/to/files/*.ext, other/path/**/*
12  alwaysApply: boolean
13  ---
14 
15  - **Main Points in Bold**
16    - Sub-points with details
17    - Examples and explanations
18```
19 
20- **File References:**
21  - Use `[filename](mdc:path/to/file)` ([filename](mdc:filename)) to reference files
22  - Example: [prisma.mdc](mdc:.cursor/rules/prisma.mdc) for rule references
23  - Example: [schema.prisma](mdc:prisma/schema.prisma) for code references
24 
25- **Code Examples:**
26  - Use language-specific code blocks
27```typescript
28  // ✅ DO: Show good examples
29  const goodExample = true;
30  
31  // ❌ DON'T: Show anti-patterns
32  const badExample = false;
33```
34 
35- **Rule Content Guidelines:**
36  - Start with high-level overview
37  - Include specific, actionable requirements
38  - Show examples of correct implementation
39  - Reference existing code when possible
40  - Keep rules DRY by referencing other rules
41 
42- **Rule Maintenance:**
43  - Update rules when new patterns emerge
44  - Add examples from actual codebase
45  - Remove outdated patterns
46  - Cross-reference related rules
47 
48- **Best Practices:**
49  - Use bullet points for clarity
50  - Keep descriptions concise
51  - Include both DO and DON'T examples
52  - Reference actual code over theoretical examples
53  - Use consistent formatting across rules