Cursor rule

1---
2description: Standards for code generation and implementation
3globs: *.php, *.js, *.ts, *.vue, *.jsx, *.tsx, *.py
4---
5# Enhanced Code Generation Standards
6 
7Ensures high-quality, executable code generation adhering to best practices across multiple programming languages.
8 
9## Rule Details
10 
11- **Name:** enhanced_code_generation_standards
12 
13- **Description:** Enforce standards for code generation ensuring high quality and integration readiness
14 
15## Filters
16- file extension pattern: `"\\.(php|js|ts|vue|jsx|tsx|py|rb|java)$"  # Expanded to include Ruby and Java`
17 
18## Enforcement Checks
19- Conditions:
20  - pattern `// TODO:|#\\s*TODO:` – Replace TODOs with actual implementation - no placeholders allowed.
21  - pattern `function\\s+\\w+\\s*\\([^)]*\\)\\s*\\{\\s*(?:return\\s+null|throw\\s+new\\s+Error|console\\.log)\\s*\\}` – Implement full functionality - no stub methods.
22  - pattern `\\bif\\b\\s*\\(\\s*false\\s*\\)` – Remove or replace conditional statements that are always false.
23  - pattern `\\bconsole\\.[^(]+|print\\s*\\(` – negated `DEBUG|LOGGING` – Remove debug logging unless it's conditional on a debug flag.
24  - pattern `^\\s*#\\s*\\w+:\\s*\\w+\\s*$` – In Python, prefer type hints over comments for type annotations.
25 
26## Suggestions
27- Guidance:
28**Code Generation Best Practices:**
29- **Executable Solutions:** Generate fully functional code, not just skeletons or stubs.
30- **Readability:** 
31  - Prioritize code readability, with clear naming conventions and logical structure.
32  - Use whitespace effectively to enhance code clarity.
33- **Error Handling:** 
34  - Implement comprehensive error handling with appropriate exceptions or error codes.
35  - Consider edge cases and provide meaningful error messages.
36- **Imports/Dependencies:** 
37  - Include all necessary imports or require statements at the beginning of the file.
38  - Manage dependencies to ensure the code is self-contained or clearly documented for setup.
39- **Integration:** 
40  - Code should be immediately usable within the project's existing framework or technology stack.
41  - Ensure compatibility with existing patterns or libraries used in the project.
42- **Formatting:** 
43  - Adhere to the project's coding style guide (e.g., Prettier, Black for Python, etc.).
44  - Use linters and formatters to maintain consistent code style.
45- **Testing:** 
46  - Include unit or integration tests where applicable to validate generated code.
47  - Encourage test-driven development if part of the project's culture.
48- **Documentation:** 
49  - Provide inline comments for complex logic or algorithms.
50  - Write docstrings or JSDoc for functions, classes, and modules to describe usage, parameters, and return values.
51  - Consider generating external documentation if the project uses tools like Swagger for APIs or Sphinx for Python.
52- **Security:** 
53  - Avoid hardcoded credentials or sensitive information.
54  - Follow security best practices for the language (e.g., SQL injection prevention in PHP, XSS in JavaScript).
55- **Performance:** While readability takes precedence, be mindful of performance implications of the generated code.
56 
57## Metadata
58- Priority: critical
59- Version: 1.2
60