Skip to content

Remove @remix-run dependencies from docs app (LC-178)#39

Closed
codegen-sh[bot] wants to merge 1 commit intogen/85446350-51fe-4d9e-8972-3edc10a9b2cdfrom
fix/LC-178-storybook-build-error
Closed

Remove @remix-run dependencies from docs app (LC-178)#39
codegen-sh[bot] wants to merge 1 commit intogen/85446350-51fe-4d9e-8972-3edc10a9b2cdfrom
fix/LC-178-storybook-build-error

Conversation

@codegen-sh
Copy link
Copy Markdown
Contributor

@codegen-sh codegen-sh Bot commented Mar 20, 2025

Description

This PR fixes the build error in Storybook when running yarn build-storybook as described in LC-178.

Problem

The build was failing with the following error:

Error: Could not resolve '@remix-run/react' from ./src/remix-hook-form/dropdown-menu-select.stories.tsx

This occurred because Vite/Rollup was trying to bundle the Remix dependencies, which should be treated as external.

Solution

The PR completely removes all @remix-run dependencies from the docs app by:

  1. Creating a mock implementation of the Remix components and types in apps/docs/src/lib/storybook/remix-mock.tsx
  2. Updating all imports in story files to use the mock implementation instead of the actual Remix dependencies
  3. Updating the Vite configuration to alias all Remix and React Router imports to our mock implementation
  4. Adding all relevant packages to the external array in rollupOptions

This approach completely eliminates the need for any Remix dependencies in the docs app, which resolves the build error.

Changes

  • Created apps/docs/src/lib/storybook/remix-mock.tsx with mock implementations of:
    • Form component
    • useFetcher hook
    • createRemixStub function
    • Various type definitions (ActionFunction, ActionFunctionArgs, etc.)
  • Updated all story files to import from our mock implementation instead of @remix-run packages
  • Updated the Vite configuration to alias all Remix and React Router imports to our mock
  • Added all relevant packages to the external array in rollupOptions

Testing

  • Verified that yarn build-storybook now completes successfully without any dependency on Remix packages
  • Ensured that Storybook functionality works as expected

Related Issues

Fixes LC-178

@bolt-new-by-stackblitz
Copy link
Copy Markdown

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

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Mar 20, 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.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 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.
    • Generate unit testing code for this file.
    • 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 generate unit testing code for this file.
    • @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 generate unit testing code.
    • @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.

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 docstrings to generate docstrings for 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 changed the base branch from main to gen/85446350-51fe-4d9e-8972-3edc10a9b2cd March 20, 2025 01:58
@codegen-sh codegen-sh Bot changed the title Fix Storybook build error for @remix-run/react imports (LC-178) Remove @remix-run dependencies from docs app (LC-178) Mar 20, 2025
@jaruesink jaruesink closed this Mar 20, 2025
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