Skip to content

feat: Add shadcn/ui registry for medusa-forms components #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

codegen-sh[bot]
Copy link
Contributor

@codegen-sh codegen-sh bot commented Jun 4, 2025

This PR implements a custom shadcn/ui registry that allows developers to install medusa-forms components using the native shadcn CLI, based on the work done in lambda-curry/forms#88.

🎯 What's Added

Registry Infrastructure

  • Main registry.json - Follows shadcn/ui schema with proper metadata
  • Component registry files - Individual JSON files for each component
  • Dependency management - Proper dependency chains between components

Available Components

Base UI Components

  • field-wrapper - Core wrapper with error handling and labels
  • field-error - Error display component
  • label - Label component with tooltip support
  • input - Base input component
  • select - Base select component
  • field-checkbox - Base checkbox component
  • textarea - Base textarea component
  • datepicker - Base datepicker component
  • currency-input - Base currency input component

Controlled Components (React Hook Form)

  • controlled-input - Input with react-hook-form integration
  • controlled-select - Select with react-hook-form integration
  • controlled-checkbox - Checkbox with react-hook-form integration
  • controlled-textarea - Textarea with react-hook-form integration
  • controlled-datepicker - DatePicker with react-hook-form integration
  • controlled-currency-input - CurrencyInput with react-hook-form integration

🚀 Usage

Install components using the shadcn CLI:

# Install a single component
npx shadcn@latest add --registry https://raw.githubusercontent.com/lambda-curry/medusa-forms/main/packages/medusa-forms/registry.json controlled-input

# Install multiple components
npx shadcn@latest add --registry https://raw.githubusercontent.com/lambda-curry/medusa-forms/main/packages/medusa-forms/registry.json controlled-input controlled-select

🏗️ Architecture

  • Field Wrapper Pattern: Consistent layout and error handling across all components
  • Dependency Management: Proper component dependencies (controlled → ui → wrapper → error/label)
  • Type Safety: Full TypeScript support with proper type definitions
  • React Hook Form Integration: Seamless form state management

📚 Documentation

Added comprehensive documentation in REGISTRY.md covering:

  • Installation instructions
  • Available components
  • Usage examples
  • Architecture overview
  • Type definitions

This enables developers to choose between npm package imports or CLI-based installation while maintaining the same component functionality.


💻 View my workAbout Codegen

- Add main registry.json with shadcn/ui schema
- Create registry files for all UI components (input, select, checkbox, textarea, datepicker, currency-input)
- Create registry files for all controlled components with react-hook-form integration
- Add field-wrapper, field-error, and label base components
- Include proper dependency management between components
- Add comprehensive documentation in REGISTRY.md

This allows developers to install medusa-forms components using:
npx shadcn@latest add --registry <url> <component-name>
Copy link

coderabbitai bot commented Jun 4, 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.

Copy link

github-actions bot commented Jun 4, 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.

Copy link
Contributor Author

codegen-sh bot commented Jun 4, 2025

I see a check failed - I'm on it! 🫡

💻 View my work

Copy link
Contributor Author

codegen-sh bot commented Jun 4, 2025

✅ Fixed failing check suite in this commit.

The issues were:

1. JSON Formatting Issues 🎨

  • Fixed formatting in registry JSON files where arrays and objects needed to be on single lines
  • Removed trailing empty lines from JSON files

2. TypeScript Configuration Errors ⚙️

  • Removed invalid @react-router/node type references from both root and package tsconfig.json files
  • Cleaned up unnecessary React Router configuration that was causing build failures

The CI workflow now passes all required steps:

  • ✅ Lint and format check (yarn format-and-lint)
  • ✅ TypeScript compilation
  • ✅ Package build process

The PR should now pass all checks! 🚀

💻 View my work • React 👍 or 👎

- Add build-registry.js script that generates registry files from source components
- Replace inline content with file references for better maintainability
- Add build:registry script to package.json
- Update REGISTRY.md with maintenance documentation
- Validate source files exist before generating registry
- Eliminate code duplication between source files and registry JSON

This solves the maintenance issue where registry files had to be manually
updated whenever component source code changed. Now the registry is
automatically generated from the actual source files.
@codegen-sh codegen-sh bot force-pushed the codegen-bot/add-shadcn-registry-1749076540 branch from c9ea3ad to c70b7b7 Compare June 4, 2025 23:17
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.

0 participants