Skip to content

Conversation

@codegen-sh
Copy link
Contributor

@codegen-sh codegen-sh bot commented May 31, 2025

Overview

This PR adds specialized cursor rules for Medusa Forms components and stories, complementing the existing form component patterns with Medusa-specific guidance.

What's Added

🎯 medusa-forms-patterns.mdc

  • Component development patterns for Medusa Forms using @medusajs/ui and react-hook-form
  • Controller pattern implementation guidelines
  • FieldWrapper integration requirements
  • Type safety and validation patterns
  • Directory structure conventions (controlled/ vs ui/)

📚 medusa-stories-patterns.mdc

  • Storybook story patterns for Medusa Forms components
  • FormProvider and useForm setup guidelines
  • Comprehensive story categories (validation, error states, integration examples)
  • Sample data patterns and validation schemas
  • Interactive state display requirements

Key Differences from Existing Form Rules

Aspect Existing Forms Medusa Forms
Form Library remix-hook-form react-hook-form
UI Components Custom UI @medusajs/ui
Integration Pattern Wrapper pattern Controller pattern
Stories Remix patterns FormProvider patterns

Design Principles

Modular Approach: Separate files for component and story patterns
Auto-Attached: Automatically applies to relevant file patterns
Complementary: Works alongside existing cursor rules
Comprehensive: Covers validation, accessibility, and testing
Best Practices: Follows Notion document guidelines

File Targeting

  • medusa-forms-patterns.mdc: packages/medusa-forms/**/*.{ts,tsx} and apps/docs/src/medusa-forms/**/*.{ts,tsx}
  • medusa-stories-patterns.mdc: apps/docs/src/medusa-forms/**/*.stories.{ts,tsx}

Benefits

🚀 Faster Development: Clear patterns for Medusa component creation
🎨 Design System Compliance: Ensures proper @medusajs/ui integration
📖 Better Documentation: Comprehensive story examples
🔒 Type Safety: Proper TypeScript patterns and generics
Accessibility: Built-in accessibility requirements

Related

  • Based on research from PR Medusa Forms Upgrades #81 (Medusa Forms with remix-hook-form)
  • Complements existing .cursor/rules/form-component-patterns.mdc
  • Follows best practices from Notion cursor rules guide

💻 View my workAbout Codegen

- Add medusa-forms-patterns.mdc for component development patterns
- Add medusa-stories-patterns.mdc for Storybook story patterns
- Focus on @medusajs/ui integration and react-hook-form Controller patterns
- Complement existing form-component-patterns.mdc with Medusa-specific guidance
- Include validation, error handling, and accessibility requirements
- Provide comprehensive story examples and best practices
@bolt-new-by-stackblitz
Copy link

Review PR in StackBlitz Codeflow Run & review this pull request in StackBlitz Codeflow.

@coderabbitai
Copy link

coderabbitai bot commented May 31, 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.

@github-actions
Copy link
Contributor

github-actions bot commented May 31, 2025

📝 Storybook Preview: View Storybook

This preview will be updated automatically when you push new changes to this PR.

Note: The preview will be available after the workflow completes and the PR is approved for deployment.

- Update monorepo-organization.mdc with proper globs and new package structure
- Add medusa-forms package and directory structure documentation
- Update storybook-testing.mdc to include react-hook-form and @medusajs/ui
- Add medusa-forms story directory to project structure
- Update form-component-patterns.mdc to clarify scope (Remix Hook Form only)
- Add note directing to medusa-forms-patterns.mdc for Medusa components
@jaruesink jaruesink marked this pull request as ready for review May 31, 2025 04:48
@jaruesink jaruesink merged commit 2bc8ec3 into medusa-forms-upgrades May 31, 2025
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.

2 participants