Cursor rule

1---
2description: Describes how and where to create Cursor Rules
3globs: *.mdc
4---
5# Cursor Rules Location
6 
7Standards for placing and organizing Cursor rule files in the repository, ensuring rules are always up-to-date and follow best practices.
8 
9## Rule Details
10 
11- **Name:** cursor_rules_location_and_maintenance
12 
13- **Description:** Standards for placing and maintaining Cursor rule files in the correct directory
14 
15## Filters
16- file extension pattern: `\\.mdc$`
17  - Match files that look like Cursor rules
18- content: `(?s)<rule>.*?</rule>`
19  - Match file creation or modification events
20- event: `file_create|file_modify`
21 
22## Rejections
23- Conditions:
24  - pattern `^(?!\\.\\/\\.cursor\\/rules\\/.*\\.mdc$)` – Cursor rule files (.mdc) must be placed in the .cursor/rules directory
25 
26## Suggestions
27- Guidance:
28## Cursor Rules Best Practices
29 
30### 1. Location and Structure
31- **Location:** Always place rule files in **PROJECT_ROOT/.cursor/rules/**
32- **Directory Structure:**
33```
34  PROJECT_ROOT/
35  ├── .cursor/
36  │   └── rules/
37  │       ├── your-rule-name.mdc
38  │       └── ...
39  └── ...
40```
41 
42### 2. Naming Conventions
43- Use **kebab-case** for filenames (e.g., `php-drupal-standards.mdc`)
44- Always use the **.mdc** extension
45- Make names descriptive of the rule's purpose
46- Group related rules with common prefixes (e.g., `drupal-*`, `lagoon-*`)
47 
48### 3. Rule File Structure
49```
50---
51description: Brief description of the rule
52globs: *.php, *.module, *.inc
53alwaysApply: false
54---
55# Rule Title
56 
57<rule>
58name: rule_name_in_snake_case
59description: Detailed description of what the rule enforces
60filters:
61  - type: file_extension
62    pattern: "pattern_to_match"
63 
64actions:
65  - type: enforce|suggest|validate
66    conditions:
67      - pattern: "regex_pattern"
68        message: "Clear message explaining the issue"
69 
70metadata:
71  priority: high|medium|low
72  version: 1.1
73</rule>
74```
75 
76### 4. Rule Maintenance
77- **When adding new rules:**
78  - Check for overlapping or conflicting rules
79  - Ensure patterns are efficient and specific
80  - Test rules against sample code
81- **When modifying existing rules:**
82  - Update version number
83  - Document changes in commit messages
84  - Review and update related rules for consistency
85  - Consider backward compatibility
86 
87### 5. Best Practices for Rule Content
88- Use clear, specific regex patterns
89- Provide helpful, actionable messages
90- Include examples of good and bad code
91- Set appropriate priority levels
92- Use multiple conditions for complex rules
93- Consider performance impact of complex patterns
94 
95### 6. Rule Testing
96- Test rules against both compliant and non-compliant code
97- Verify that messages are clear and helpful
98- Check for false positives and false negatives
99- Ensure rules don't conflict with each other
100 
101## Metadata
102- Priority: high|medium|low
103- Version: 1.1
104- - **When Adding New Rules: **
105- - **When Modifying Existing Rules: **
106