Skip to content

feat: enhance cursor rules with practical improvements#69

Merged
jaruesink merged 1 commit intopost-section-apisfrom
codegen-bot/cursor-rules-improvements-1748537177
May 29, 2025
Merged

feat: enhance cursor rules with practical improvements#69
jaruesink merged 1 commit intopost-section-apisfrom
codegen-bot/cursor-rules-improvements-1748537177

Conversation

@codegen-sh
Copy link
Copy Markdown
Contributor

@codegen-sh codegen-sh Bot commented May 29, 2025

Overview

This PR enhances the cursor rules with practical improvements based on the Lambda Curry best practices guide, focusing on actionable guidance without making the rules too long.

🎯 Improvements Implemented

3. Query Key Management Patterns

Added centralized query key management to medusa-admin.mdc:

  • Centralized QUERY_KEYS constant for consistency
  • Proper query invalidation patterns in mutations
  • Examples showing related query invalidation

5. File Organization Rules

Enhanced file organization guidelines:

  • Clear directory structure for admin components
  • Component, hook, and type file naming conventions
  • Co-location and separation of concerns best practices
  • Test file organization patterns

6. Verification Checklists

Added comprehensive verification checklists for both backend and admin:

Backend Checklist:

  • API endpoint patterns (workflows, validation, responses)
  • Workflow best practices (atomicity, rollbacks, types)
  • Database considerations (migrations, indexes, constraints)
  • Security requirements (validation, auth, sanitization)

Admin Checklist:

  • State management (query invalidation, loading states)
  • Component patterns (event handling, TypeScript generics)
  • Performance (memoization, callbacks, optimization)
  • Error handling (async operations, user feedback)

7. Anti-Pattern Examples

Added targeted anti-pattern examples without excessive length:

Backend Examples:

  • Business logic in routes vs. workflows
  • Missing input validation vs. Zod middleware

Admin Examples:

  • Direct API calls vs. query hooks
  • Missing event.stopPropagation() vs. proper event handling
  • Missing query invalidation vs. proper cache management

🔧 Key Features

  • Practical Focus: All examples are actionable and specific
  • Concise Format: Anti-patterns are brief but illustrative
  • Real-World Patterns: Based on actual implementation needs
  • Verification-Driven: Clear checklists for code quality
  • Organized Structure: Logical grouping and easy navigation

Benefits

  • Faster Code Reviews: Clear verification checklists reduce review time
  • Consistent Patterns: Centralized query management and file organization
  • Quality Assurance: Anti-patterns help avoid common mistakes
  • Developer Productivity: Clear guidelines reduce decision fatigue
  • Maintainable Code: Better organization and testing patterns

This implementation follows the Lambda Curry guide's emphasis on practical, actionable rules while maintaining brevity and focus.


💻 View my workAbout Codegen

- Add centralized query key management patterns
- Implement comprehensive verification checklists for backend and admin
- Add file organization best practices and structure guidelines
- Include targeted anti-pattern examples with code snippets
- Enhance testing patterns for workflows and components
- Focus on practical, actionable guidance without excessive length

Based on Lambda Curry best practices guide recommendations
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 29, 2025

Important

Review skipped

Bot user detected.

To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Join our Discord community for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@jaruesink jaruesink marked this pull request as ready for review May 29, 2025 16:54
@jaruesink jaruesink merged commit 2795525 into post-section-apis May 29, 2025
1 of 3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant