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

chore(deps): bump tailwind-merge version #3657

Open
wants to merge 3 commits into
base: canary
Choose a base branch
from
Open

Conversation

wingkwong
Copy link
Member

@wingkwong wingkwong commented Aug 15, 2024

Closes #3614

📝 Description

tailwind-merge is still using v1. Upgrade to v2.

⛳️ Current behavior (updates)

Please describe the current behavior that you are modifying

🚀 New behavior

Please describe the behavior or changes this PR adds

💣 Is this a breaking change (Yes/No):

📝 Additional Information

Summary by CodeRabbit

  • Chores
    • Updated the tailwind-merge dependency to the latest version for improved styling capabilities and performance.
    • Ensured compatibility with the latest features from the Tailwind CSS ecosystem.

Copy link

linear bot commented Aug 15, 2024

Copy link

vercel bot commented Aug 15, 2024

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

Name Status Preview Comments Updated (UTC)
nextui-docs-v2 ✅ Ready (Inspect) Visit Preview 💬 Add feedback Aug 15, 2024 4:16am
nextui-storybook-v2 ✅ Ready (Inspect) Visit Preview 💬 Add feedback Aug 15, 2024 4:16am

Copy link

changeset-bot bot commented Aug 15, 2024

🦋 Changeset detected

Latest commit: 1050818

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

This PR includes changesets to release 2 packages
Name Type
@nextui-org/theme Patch
@nextui-org/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

@wingkwong wingkwong added this to the v2.5.0 milestone Aug 15, 2024
Copy link
Contributor

coderabbitai bot commented Aug 15, 2024

Walkthrough

This change focuses on updating the tailwind-merge dependency within the @nextui-org/theme package. By upgrading from version ^1.14.0 to ^2.5.2, the project enhances compatibility with the latest Tailwind CSS features and bug fixes. Additionally, modifications in the configuration of the twMerge utility allow for improved styling capabilities, addressing specific issues related to new default configurations introduced in the latest tailwind-merge version.

Changes

Files and Directories Change Summary
packages/core/theme/package.json Updated tailwind-merge version from ^1.14.0 to ^2.5.2.
packages/core/theme/src/utils/cn.ts Initialization of const twMerge changed to extendTailwindMerge({extend: twMergeConfig}).
packages/core/theme/src/utils/tw-merge-config.ts Updated export const twMergeConfig to reflect changes in configuration.

Assessment against linked issues

Objective Addressed Explanation
Upgrade Tailwind Merge version (#3614)
Ensure compatibility with new default config (#3614)
Fix styling issues with cn function (#3614)

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

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 1973864 and 1050818.

Files ignored due to path filters (1)
  • pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml
Files selected for processing (4)
  • .changeset/grumpy-mayflies-rhyme.md (1 hunks)
  • packages/core/theme/package.json (1 hunks)
  • packages/core/theme/src/utils/cn.ts (1 hunks)
  • packages/core/theme/src/utils/tw-merge-config.ts (1 hunks)
Files skipped from review due to trivial changes (1)
  • .changeset/grumpy-mayflies-rhyme.md
Additional comments not posted (3)
packages/core/theme/src/utils/tw-merge-config.ts (1)

3-3: Consider the implications of removing explicit type annotations.

The removal of the explicit type Partial<Config> from twMergeConfig may increase flexibility by relying on TypeScript's type inference. However, this can potentially reduce type safety if the inferred type does not match the expected structure. Ensure that this change aligns with your project's type safety requirements.

packages/core/theme/src/utils/cn.ts (1)

13-13: Verify compatibility with the new configuration structure.

The change to use {extend: twMergeConfig} in extendTailwindMerge likely aims to provide more flexible configuration handling. Ensure that the extend key is correctly processed by the extendTailwindMerge function and that it aligns with the expected configuration structure.

packages/core/theme/package.json (1)

60-60: Verify compatibility of the updated tailwind-merge dependency.

The update to tailwind-merge version ^2.5.2 likely includes new features and bug fixes. Ensure that this version is compatible with your current codebase and does not introduce any breaking changes, especially in how class names are merged.

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.

[BUG] - Upgrade Tailwind Merge version
2 participants