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