themesberg / flowbite-react

Official React components built for Flowbite and Tailwind CSS
https://flowbite-react.com
MIT License
1.77k stars 395 forks source link

packages(ui): build step using rollup + tsc #1344

Closed SutuSebastian closed 3 months ago

SutuSebastian commented 3 months ago

Summary

In order to bring more performance to the build process of flowbite-react package, we have to consider transpiling the files using other tools rather than tsc, which is very slow.

After evaluating various tools including tsup, tshy, and bun build, we chose rollup with the esbuild plugin for transpiling due to its performance and flexibility. We continue to use tsc solely for generating *.d.ts declaration files.

Changes

Breaking changes

tailwind.config.js content path:

old: "node_modules/flowbite-react/lib/esm/**/*.js"

new: "node_modules/flowbite-react/dist/esm/**/*.mjs" - (flowbite.content() returns it)

Before

/** @type {import('tailwindcss').Config} */
module.exports = {
  content: [
    // ...
    "node_modules/flowbite-react/lib/esm/**/*.js",
  ],
  plugins: [
    // ...
    require("flowbite/plugin"),
  ],
};

After

const flowbite = require("flowbite-react/tailwind");

/** @type {import('tailwindcss').Config} */
module.exports = {
  content: [
    // ...
    flowbite.content(),
  ],
  plugins: [
    // ...
    flowbite.plugin(),
  ],
};

Issues

1326, #1329, #1343

Summary by CodeRabbit

changeset-bot[bot] commented 3 months ago

πŸ¦‹ Changeset detected

Latest commit: 50c7cddfd94c4576c3681fe7069dbd28beef38fc

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 | Minor |

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

coderabbitai[bot] commented 3 months ago

[!WARNING]

Rate Limit Exceeded

@SutuSebastian has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 9 minutes and 7 seconds before requesting another review.

How to resolve this issue? After the wait time has elapsed, a review can be triggered using the `@coderabbitai review` command as a PR comment. Alternatively, push new commits to this PR. We recommend that you space out your commits to avoid hitting the rate limit.
How do rate limits work? CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our [FAQ](https://coderabbit.ai/docs/faq) for further information.
Commits Files that changed from the base of the PR and between 70f804d6de100cb543d477814649ae9ebe5673d0 and 50c7cddfd94c4576c3681fe7069dbd28beef38fc.

Walkthrough

The overarching change focuses on enhancing the build process and integration of flowbite-react with Tailwind CSS across various frameworks. It shifts from tsc to rollup and esbuild for better performance, updates documentation to streamline the installation and configuration process, and modifies file structures and dependency configurations for improved management. This comprehensive update aims to optimize the development workflow and ensure a smoother integration of Flowbite React with Tailwind CSS in diverse development environments.

Changes

Files Summary
.changeset/hungry-toys-care.md Transitioned build process from tsc to rollup with esbuild, updated file extensions and output directories, refactored dependencies.
apps/web/content/docs/.../introduction.mdx, .../astro.mdx, .../create-react-app.mdx, .../gatsby.mdx, .../laravel.mdx, .../next-js.mdx, .../parcel.mdx, .../redwood-js.mdx, .../remix.mdx, .../vite.mdx Updated installation instructions for Tailwind CSS and integration steps for Flowbite React in various guides.
apps/web/tailwind.config.cjs, apps/web/turbo.json, package.json Modified tailwind.config.cjs, updated turbo.json dependencies, removed post-install script in package.json.
packages/ui/... (Multiple files) Updated ESLint and .gitignore configurations, paths in package.json, introduced rollup.config.mjs, updated TypeScript settings, added new dependencies.

🐰✨
In the realm of code, where the bits entwine,
A rabbit hopped through, making changes so fine.
With a flick and a hop, it transformed the night,
Rollup and esbuild, making builds light.
Flowbite and Tailwind, together they dance,
In a whirl of colors, they enhance.
πŸŒŸπŸ“¦πŸΎ

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 - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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 show all the console.log statements in this repository.` - `@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.` 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 as PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger a review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configration 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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/coderabbit-overrides.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
vercel[bot] commented 3 months ago

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 Apr 4, 2024 0:25am
flowbite-react-storybook βœ… Ready (Inspect) Visit Preview πŸ’¬ Add feedback Apr 4, 2024 0:25am