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

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

Merged
merged 24 commits into from
Apr 4, 2024

Conversation

SutuSebastian
Copy link
Collaborator

@SutuSebastian SutuSebastian commented Apr 2, 2024

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

  • added rollup + esbuild for transpiling files
    • all files in the cjs directory now have .cjs extension
    • all files in the esm directory now have .mjs extension
    • declaration file types (*.d.ts) have been moved from dist/esm to dist/types
  • changed the build output dir from lib to dist
  • created a facade layer for easier management of the content path as well as the plugin
  • fixed turbo repo dependency tree configs in order for apps/web to properly pipe and require the build output of packages/ui in certain script steps such as build and dev
  • update docs introduction and integration guides pages to use the new utility for tailwind content and plugins

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

  • New Features

    • Transitioned the build process of flowbite-react for improved performance.
    • Streamlined installation and configuration instructions for integrating Tailwind CSS with Flowbite React across various frameworks (Astro, Create React App, Gatsby, Laravel, Next.js, Parcel, Redwood.js, Remix, Vite).
  • Documentation

    • Updated documentation to reflect new installation steps and configuration setups for Tailwind CSS and Flowbite React.
  • Refactor

    • Changed build scripts and dependencies in packages/ui to enhance build efficiency.
    • Updated ESLint and .gitignore configurations to align with new directory structures.
  • Chores

    • Adjusted turbo.json and package.json configurations for optimized build and development processes.

@SutuSebastian SutuSebastian added the 🚀 enhancement New feature or request label Apr 2, 2024
@SutuSebastian SutuSebastian self-assigned this Apr 2, 2024
Copy link

changeset-bot bot commented Apr 2, 2024

🦋 Changeset detected

Latest commit: 50c7cdd

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

Copy link
Contributor

coderabbitai bot commented Apr 2, 2024

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 for further information.

Commits Files that changed from the base of the PR and between 70f804d and 50c7cdd.

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

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>.
    • 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 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 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

vercel bot commented Apr 2, 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 Apr 4, 2024 0:25am
flowbite-react-storybook ✅ Ready (Inspect) Visit Preview 💬 Add feedback Apr 4, 2024 0:25am

chore: apps(web) - update `tailwind.config` to use `.mjs`
…the `content` and `plugins` values for `tailwind.config.js`

- change build output folder from `lib` to `dist`
-
chore: apps(web): use new plugi in `tailwind.config`
…wind` file which exports getters for `content` and `plugin`

chore: apps(web): use new `flowbite-react/tailwind` in `tailwind.config`
SutuSebastian and others added 2 commits April 4, 2024 15:20
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
rluders
rluders previously approved these changes Apr 4, 2024
@SutuSebastian SutuSebastian merged commit bf1bdb0 into main Apr 4, 2024
8 checks passed
@SutuSebastian SutuSebastian deleted the refactor/packages(ui)/build-step branch April 4, 2024 12:29
@github-actions github-actions bot mentioned this pull request Apr 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🚀 enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants