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

Bump @ant-design/icons to match antd #8826

Merged
merged 1 commit into from
Dec 17, 2024

Conversation

SpecLad
Copy link
Contributor

@SpecLad SpecLad commented Dec 13, 2024

Motivation and context

cvat-ui depends on icons v4, but antd depends on icons v5. Fixing this discrepancy gets rid of a few duplicate dependencies.

How has this been tested?

Checklist

  • I submit my changes into the develop branch
  • [ ] I have created a changelog fragment
  • [ ] I have updated the documentation accordingly
  • [ ] I have added tests to cover my changes
  • [ ] I have linked related issues (see GitHub docs)
  • [ ] I have increased versions of npm packages if it is necessary
    (cvat-canvas,
    cvat-core,
    cvat-data and
    cvat-ui)

License

  • I submit my code changes under the same MIT License that covers the project.
    Feel free to contact the maintainers if that's a concern.

Summary by CodeRabbit

  • New Features

    • Updated the icons library to include new icons and improvements.
  • Bug Fixes

    • Potential bug fixes included with the upgrade of the icons library.

cvat-ui depends on icons v4, but antd depends on icons v5. Fixing this
discrepancy gets rid of a few duplicate dependencies.
Copy link
Contributor

coderabbitai bot commented Dec 13, 2024

Walkthrough

The package.json file for the cvat-ui project has been updated to reflect a change in the version of the @ant-design/icons dependency. The version has been upgraded from ^4.6.3 to ^5.5.2, indicating an update to a newer version of the icons library. No other dependencies were modified in this update.

Changes

File Change Summary
cvat-ui/package.json Updated @ant-design/icons from ^4.6.3 to ^5.5.2

Poem

In the garden of code, a change took flight,
Icons refreshed, oh what a sight! 🌼
From four to five, they leap and dance,
A vibrant upgrade, a joyful chance.
Hopping along, we celebrate this cheer,
New icons to brighten our UI, oh dear! 🐇✨


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between c729f18 and 13612a0.

⛔ Files ignored due to path filters (1)
  • yarn.lock is excluded by !**/yarn.lock, !**/*.lock
📒 Files selected for processing (1)
  • cvat-ui/package.json (1 hunks)
🔇 Additional comments (2)
cvat-ui/package.json (2)

24-24: LGTM! Version alignment looks correct.

The update to @ant-design/icons@^5.5.2 properly aligns with [email protected] and @ant-design/compatible@^5.1.2, which should resolve the duplicate dependencies issue.


24-24: Verify impact of breaking changes from v4 to v5.

Since this is a major version upgrade (v4 to v5), we should verify that all icon usages in the codebase are compatible with the new version.

Please review the search results to ensure:

  1. No deprecated import patterns are used
  2. Icon components are used according to v5 specifications
✅ Verification successful

No breaking changes impact detected from @ant-design/icons v4 to v5

Based on the analysis of icon imports and usage patterns in the codebase:

  1. All icon imports follow the v5-compatible pattern using named imports from '@ant-design/icons'
  2. No usage of deprecated @ant-design/icons-react package
  3. No usage of createFromIconfontCN which had breaking changes
  4. Limited usage of TwoTone icons (only in 2 components) which are still supported in v5
  5. The generic Icon component imports are compatible with v5
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Search for @ant-design/icons imports and usages to verify compatibility

# Check direct icon imports
echo "Checking direct icon imports..."
rg -t tsx -t ts "from '@ant-design/icons'" ./cvat-ui/src

# Check icon component usage patterns that might need updates
echo "Checking icon usage patterns..."
rg -t tsx -t ts "<[A-Z][a-zA-Z]*Icon" ./cvat-ui/src

Length of output: 320


Script:

#!/bin/bash
# Let's try without file type restrictions since rg doesn't recognize tsx
echo "Checking direct icon imports..."
rg "from '@ant-design/icons'" ./cvat-ui/src

echo -e "\nChecking icon usage patterns..."
rg "<[A-Z][a-zA-Z]*Icon" ./cvat-ui/src

echo -e "\nChecking specific deprecated patterns..."
# Check for type Icon from @ant-design/icons-react which was removed in v5
rg "Icon.*from.*@ant-design/icons-react" ./cvat-ui/src

# Check for createFromIconfontCN which had breaking changes
rg "createFromIconfontCN" ./cvat-ui/src

# Check for two-tone icon usage which had breaking changes
rg "TwoTone" ./cvat-ui/src

Length of output: 22985


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 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. (Experiment)
  • @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.

@SpecLad SpecLad requested a review from klakhov December 16, 2024 10:45
@SpecLad SpecLad merged commit 4d26d5c into cvat-ai:develop Dec 17, 2024
36 checks passed
@SpecLad SpecLad deleted the bump-antd-icons branch December 17, 2024 12:47
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.

2 participants