Skip to content

feat: render DisplayName in Icons for better DX#326

Merged
joacotornello merged 4 commits intomasterfrom
feat/icon-displayname
Aug 4, 2025
Merged

feat: render DisplayName in Icons for better DX#326
joacotornello merged 4 commits intomasterfrom
feat/icon-displayname

Conversation

@joacotornello
Copy link
Copy Markdown
Contributor

@joacotornello joacotornello commented Aug 1, 2025

Type

  • Bugfix 🐛
  • New feature 🌈
  • Change request 🤓
  • Documentation 📚
  • Tech debt 👩‍💻

Screenshots

Before:

(notice the Anonymous showing up instead of the Icon component name)
Captura de pantalla 2025-08-01 a la(s) 11 54 13 a  m

After:

Captura de pantalla 2025-08-01 a la(s) 11 56 27 a  m

Summary by CodeRabbit

  • New Features
    • Icons now display their component names correctly in debugging tools, making it easier to identify them during development.
  • Documentation
    • Updated changelog to include details of the new icon displayName feature.

@joacotornello joacotornello requested a review from a team August 1, 2025 15:00
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Aug 1, 2025

Warning

Rate limit exceeded

@joacotornello has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 3 minutes and 32 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

Reviewing files that changed from the base of the PR and between b9738bf and 88082a1.

📒 Files selected for processing (1)
  • packages/icons/CHANGELOG.md (1 hunks)
📝 Walkthrough

Walkthrough

A changelog entry was added for version 1.12.0 of the icons package, documenting a new feature. In the component template, the React component's displayName property is now explicitly set to the component's name, enhancing debugging visibility. No exported APIs or logic were otherwise modified.

Changes

Cohort / File(s) Change Summary
Changelog Update
packages/icons/CHANGELOG.md
Added a new entry for v1.12.0 noting the addition of component displayName for debugging.
Component Template Enhancement
packages/icons/templates/components.js
Modified the template to assign displayName to React components after declaration.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Suggested labels

enhancement

✨ Finishing Touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch feat/icon-displayname

🪧 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai generate unit tests to generate unit tests for this 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 or @autosummary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai or @autotitle anywhere in the PR title to generate the title automatically.

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.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Aug 1, 2025

Getting started

Please make sure you read our documentation on how to write code for components, stories and styles.

  • Provide a list of changes
  • Include images to help better visualize your work
  • If your PR closes an issue, please link it
  • Add reviewers
  • Add a label to help better understand what your changes are related to

Copy link
Copy Markdown
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: 1

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
Knowledge Base: Disabled due to Reviews > Disable Knowledge Base setting

📥 Commits

Reviewing files that changed from the base of the PR and between 50f91d0 and 5a6f0bf.

⛔ Files ignored due to path filters (1)
  • .yarn/versions/57efeb47.yml is excluded by !**/.yarn/**
📒 Files selected for processing (2)
  • packages/icons/CHANGELOG.md (1 hunks)
  • packages/icons/templates/components.js (1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
**/CHANGELOG.md

⚙️ CodeRabbit Configuration File

Ensure CHANGELOG.md updates follow the established format: YYYY-MM-DD version with categorized entries (Breaking changes, New features, Bug fixes, Others). Each entry must include PR reference and author, and changes must be properly versioned (major/minor/patch). Changes MUST be documented in their respective package's CHANGELOG.md.

Files:

  • packages/icons/CHANGELOG.md
🪛 markdownlint-cli2 (0.17.2)
packages/icons/CHANGELOG.md

7-7: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4

(MD001, heading-increment)

🔇 Additional comments (1)
packages/icons/templates/components.js (1)

23-24: displayName assignment LGTM

Explicitly setting Component.displayName right after definition is the canonical pattern for clearer React DevTools output. No issues spotted.

Comment thread packages/icons/CHANGELOG.md
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Copy link
Copy Markdown
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: 2

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
Knowledge Base: Disabled due to Reviews > Disable Knowledge Base setting

📥 Commits

Reviewing files that changed from the base of the PR and between 5a6f0bf and b9738bf.

⛔ Files ignored due to path filters (1)
  • .yarn/versions/57efeb47.yml is excluded by !**/.yarn/**
📒 Files selected for processing (1)
  • packages/icons/CHANGELOG.md (1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
**/CHANGELOG.md

⚙️ CodeRabbit Configuration File

Ensure CHANGELOG.md updates follow the established format: YYYY-MM-DD version with categorized entries (Breaking changes, New features, Bug fixes, Others). Each entry must include PR reference and author, and changes must be properly versioned (major/minor/patch). Changes MUST be documented in their respective package's CHANGELOG.md.

Files:

  • packages/icons/CHANGELOG.md
🪛 markdownlint-cli2 (0.17.2)
packages/icons/CHANGELOG.md

7-7: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4

(MD001, heading-increment)


9-9: Lists should be surrounded by blank lines

(MD032, blanks-around-lists)

⏰ Context from checks skipped due to timeout of 30000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
  • GitHub Check: Analyze SonarCloud
  • GitHub Check: pipeline-quality

Comment thread packages/icons/CHANGELOG.md
Comment thread packages/icons/CHANGELOG.md
@codecov-commenter
Copy link
Copy Markdown

⚠️ Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 99.34%. Comparing base (6397d90) to head (b9738bf).
⚠️ Report is 1 commits behind head on master.
❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #326   +/-   ##
=======================================
  Coverage   99.34%   99.34%           
=======================================
  Files         351      351           
  Lines        2597     2597           
  Branches      430      430           
=======================================
  Hits         2580     2580           
  Misses         15       15           
  Partials        2        2           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Aug 1, 2025

🚀✨ Your Storybook preview is ready!

🔗 View Storybook

Happy reviewing! 🎉

@sonarqubecloud
Copy link
Copy Markdown

sonarqubecloud Bot commented Aug 1, 2025

@joacotornello joacotornello merged commit 882493e into master Aug 4, 2025
8 checks passed
@joacotornello joacotornello deleted the feat/icon-displayname branch August 4, 2025 12:26
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.

3 participants