d176e40726
# refactor: restructure .cursor directory for improved organization and clarity ## Description This PR refactors the `.cursor` directory to enhance organization, clarity, and maintainability. ### Problem The existing `.cursor` directory lacked clear organization, making it difficult to find specific files, understand their purpose, and add new components consistently. ### Solution A comprehensive restructuring: #### New Directory Structure ``` .cursor/ ├── settings.json # Main configuration file ├── docs/ # Documentation │ ├── guides/ # In-depth guides │ ├── references/ # Quick references │ └── practices/ # Best practices ├── rules/ # Rule definitions │ ├── commit/ # Commit-related rules │ ├── quality/ # Code quality rules │ ├── testing/ # Testing rules │ └── verification/ # Verification rules └── hooks/ # Git hooks and scripts ``` #### Key Changes 1. **Logical Categorization**: Organized files into clear categories based on purpose 2. **Improved Documentation**: Added comprehensive README files for each directory 3. **Standardized Naming**: Implemented consistent kebab-case naming convention 4. **Reference Updates**: Updated all internal references to point to new file locations ### Benefits - **Easier Navigation**: Clear categorization makes finding files intuitive - **Improved Understanding**: Comprehensive documentation explains purpose and usage - **Simplified Maintenance**: Logical structure makes updates and additions easier - **Better Onboarding**: New team members can quickly understand the system This refactoring sets a solid foundation for all Cursor AI-related configurations and rules, making it easier for the team to leverage Cursor's capabilities.
107 lines
3.4 KiB
JSON
107 lines
3.4 KiB
JSON
{
|
|
"commitRules": {
|
|
"style": {
|
|
"concise": true,
|
|
"singleLine": true,
|
|
"format": {
|
|
"prefix": "verb",
|
|
"allowedPrefixes": [
|
|
"adds",
|
|
"removes",
|
|
"updates",
|
|
"fixes",
|
|
"refactors",
|
|
"implements",
|
|
"improves"
|
|
],
|
|
"bigChanges": {
|
|
"format": "heading + description",
|
|
"separator": "\n\n"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"workspaceRules": {
|
|
"derivedFiles": {
|
|
"commentStyle": {
|
|
"forbidden": "//",
|
|
"required": "/*** */"
|
|
}
|
|
},
|
|
"cypressTests": {
|
|
"runCommand": {
|
|
"directory": "app/client",
|
|
"command": "yarn cypress run --browser chrome --headless --spec {fileName}",
|
|
"filePathFormat": {
|
|
"input": "app/client/cypress/e2e/...",
|
|
"usage": "cypress/e2e/..."
|
|
}
|
|
}
|
|
},
|
|
"reactHooks": {
|
|
"bestPractices": {
|
|
"required": true,
|
|
"rules": {
|
|
"safePropertyAccess": {
|
|
"required": true,
|
|
"description": "Use lodash/get or optional chaining for nested property access",
|
|
"examples": ".cursor/docs/react_hooks_circular_dependency_lessons.md#1.-Safe-nested-property-access-using-lodash/get"
|
|
},
|
|
"preventCircularDependencies": {
|
|
"required": true,
|
|
"description": "Use useRef to track previous values and implement directional updates",
|
|
"examples": ".cursor/docs/react_hooks_circular_dependency_lessons.md#2.-Tracking-previous-values-with-useRef"
|
|
},
|
|
"earlyReturns": {
|
|
"required": true,
|
|
"description": "Implement early returns when values haven't changed to prevent unnecessary updates",
|
|
"examples": ".cursor/docs/react_hooks_circular_dependency_lessons.md#3.-Directional-updates"
|
|
},
|
|
"deepComparisons": {
|
|
"required": true,
|
|
"description": "Use deep equality checks for comparing objects and arrays",
|
|
"examples": ".cursor/docs/react_hooks_circular_dependency_lessons.md#4.-Deep-comparisons-for-complex-objects"
|
|
}
|
|
},
|
|
"analyzer": ".cursor/rules/react_hook_best_practices.mdc"
|
|
}
|
|
},
|
|
"testingRequirements": {
|
|
"bugFixes": {
|
|
"required": true,
|
|
"tests": {
|
|
"unit": {
|
|
"required": true,
|
|
"description": "Unit tests must verify the specific fix and ensure no regressions"
|
|
},
|
|
"e2e": {
|
|
"required": "for user-facing changes",
|
|
"description": "End-to-end tests must verify the fix works in the application context"
|
|
}
|
|
},
|
|
"examples": {
|
|
"unit": ".cursor/rules/test_generator.mdc#Bug-Fix-Test-Example-(Unit-Test)",
|
|
"e2e": ".cursor/rules/test_generator.mdc#Bug-Fix-Test-Example-(E2E-Test)"
|
|
}
|
|
},
|
|
"features": {
|
|
"required": true,
|
|
"tests": {
|
|
"unit": {
|
|
"required": true,
|
|
"description": "Unit tests must cover core functionality and edge cases"
|
|
},
|
|
"integration": {
|
|
"required": "for complex features",
|
|
"description": "Integration tests must verify interactions between components"
|
|
},
|
|
"e2e": {
|
|
"required": "for user-facing features",
|
|
"description": "End-to-end tests must verify the feature works in the application context"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|