Skip to content
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

feat: add additional direct path exports #1490

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

theogravity
Copy link

@theogravity theogravity commented Sep 16, 2024

See: #1489

Summary: Next.js has extremely long compile times when starting up in dev mode as it will compile all exports for referenced imports. A majority of us will import components directly from flowbite-react, meaning that Next.js will compile all the exports found in the entrypoint file. The "proper" way to import in Next.js is to import items individually via their direct path.

import { Table } from "flowbite-react"

should be instead:

import { Table } from "flowbite-react/components/Table

This PR adds additional exports that allows direct access to things like createTheme, etc.

Summary by CodeRabbit

  • New Features
    • Introduced new export mappings for helpers, hooks, theme, and theme-store in the UI package, enhancing modularization and organization.
    • Expanded the build process to include additional source files for better usability of the UI package.
    • Added additional package exports in the "flowbite-react" package, improving usability and flexibility for developers.

These changes improve the developer experience and maintainability of the codebase.

Copy link

changeset-bot bot commented Sep 16, 2024

🦋 Changeset detected

Latest commit: 0abb0df

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
flowbite-react Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

Copy link

vercel bot commented Sep 16, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
flowbite-react ✅ Ready (Inspect) Visit Preview 💬 Add feedback Sep 16, 2024 5:59pm
flowbite-react-storybook ✅ Ready (Inspect) Visit Preview 💬 Add feedback Sep 16, 2024 5:59pm

Copy link
Contributor

coderabbitai bot commented Sep 16, 2024

Walkthrough

The changes in this pull request involve updates to the package.json and rollup.config.mjs files within the packages/ui module. New export mappings for components such as helpers, hooks, theme, and theme-store have been added to the package.json, enhancing modularization. Additionally, the rollup.config.mjs file has been modified to include these new components in the build process, ensuring they are captured during bundling.

Changes

File Change Summary
packages/ui/package.json Added new export mappings for helpers, hooks, theme, and theme-store with paths for types, ESM, and CJS.
packages/ui/rollup.config.mjs Expanded the entries array to include new sources for helpers, hooks, and theme store in the Rollup build process.

Possibly related issues

🐰 In the garden of code, we hop with glee,
New paths for helpers, as bright as can be!
With hooks and themes, our bundle's refined,
A joyful leap forward, in harmony aligned.
So let’s celebrate, with a twirl and a spin,
For every new export, a victory to win! 🌼✨


Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between e83e060 and 0abb0df.

Files selected for processing (3)
  • .changeset/modern-socks-learn.md (1 hunks)
  • packages/ui/package.json (1 hunks)
  • packages/ui/rollup.config.mjs (1 hunks)
Files skipped from review as they are similar to previous changes (2)
  • packages/ui/package.json
  • packages/ui/rollup.config.mjs
Additional comments not posted (2)
.changeset/modern-socks-learn.md (2)

1-3: LGTM!

The changeset file follows the correct format, and the choice of a patch version bump for adding new exports is appropriate.


5-5: Please provide more details about the new exports.

The changeset message mentions adding additional package exports, but it doesn't provide specifics. To better understand the impact and necessity of these changes, please include the following details:

  1. What are the names and purposes of the new exports?
  2. How do these exports improve the usability or flexibility of the library?
  3. Are there any breaking changes or deprecations associated with these new exports?
  4. Have the new exports been documented properly?

Providing this information will help reviewers assess the quality and usefulness of the proposed changes more effectively.


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

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 generate interesting stats about this repository and render them as a table.
    -- @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 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.

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