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

IEP-1331 Info message in CMakeMainTab is barely visible on Ubuntu #1056

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

sigmaaa
Copy link
Collaborator

@sigmaaa sigmaaa commented Sep 30, 2024

Description

The system background info color could be barely visible on Ubuntu and other OS:
image

To fix it, but keep the colors look and feel like in the OS, I've changed the system color to the information background color from the color registry which is different based on the selected theme, which is also helpful with different color themes.
The color is also changeable via eclipse preferences like this: General -> Appearance -> Colors and Fonts -> Basic -> Information background color

Fixes # (IEP-1331

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)

How has this been tested?

verify background color on ubuntu

Test Configuration:

  • ESP-IDF Version:
  • OS (Windows,Linux and macOS):

Dependent components impacted by this PR:

  • Component 1
  • Component 2

Checklist

  • PR Self Reviewed
  • Applied Code formatting
  • Added Documentation
  • Added Unit Test
  • Verified on all platforms - Windows,Linux and macOS

Summary by CodeRabbit

  • New Features

    • Enhanced background color management for the StyledText component to align with the current theme.
  • Bug Fixes

    • Improved flexibility in color retrieval by using a theme-based color registry instead of a static system color.

Copy link

coderabbitai bot commented Sep 30, 2024

Walkthrough

The changes involve updating the StyledInfoText.java file to modify how the background color of the StyledText component is set. The implementation now uses a CascadingColorRegistry to fetch the color from the current theme's color registry, replacing the previous method that used a static system color. Import statements have also been updated to support this new mechanism, while the overall structure and functionality of the class remain unchanged.

Changes

Files Change Summary
bundles/com.espressif.idf.swt.custom/src/com/espressif/idf/swt/custom/StyledInfoText.java Updated background color retrieval to use CascadingColorRegistry instead of a static system color. Import statements modified accordingly.

Poem

In the code where colors play,
A rabbit hops to save the day.
With themes that change and colors bright,
Our StyledText now shines just right!
Hooray for hues, both bold and new,
A joyful leap, for me and you! 🐇✨


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

Copy link

@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

🧹 Outside diff range and nitpick comments (1)
bundles/com.espressif.idf.swt.custom/src/com/espressif/idf/swt/custom/StyledInfoText.java (1)

39-43: Approved: Improved color handling, but consider internal API usage

The new color handling mechanism using CascadingColorRegistry effectively addresses the visibility issue mentioned in the PR objectives. By retrieving the color from the current theme's color registry, it should provide better consistency across different operating systems, including Ubuntu.

However, the use of @SuppressWarnings("restriction") suggests that you're using internal API. While this solution works, it's worth considering if there's a public API alternative to avoid potential future compatibility issues.

Consider exploring public API alternatives for color registry access to ensure long-term maintainability and compatibility.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 0917e35 and 207828e.

📒 Files selected for processing (1)
  • bundles/com.espressif.idf.swt.custom/src/com/espressif/idf/swt/custom/StyledInfoText.java (3 hunks)
🔇 Additional comments (2)
bundles/com.espressif.idf.swt.custom/src/com/espressif/idf/swt/custom/StyledInfoText.java (2)

Line range hint 3-20: LGTM: Import statements updated correctly

The new import statements for ColorRegistry, PlatformUI, and CascadingColorRegistry are appropriately added to support the theme-based color retrieval mechanism. These changes align with the PR objectives of improving visibility across different operating systems.


Line range hint 1-180: Verify color consistency across themes and operating systems

While the changes look good and should address the visibility issue, it's important to ensure that the new color handling works consistently across different themes and operating systems.

Please run the following verification steps:

  1. Test on different operating systems (Windows, macOS, and various Linux distributions, including Ubuntu).
  2. Test with different Eclipse themes (light, dark, and any custom themes).
  3. Verify that the information background color is visible and consistent in all scenarios.

This script will help identify other areas in the codebase where colors are set or theme-related preferences are used, which may need similar updates or could be affected by this change.

✅ Verification successful

Color consistency verified successfully

The changes in StyledInfoText.java are localized and do not impact other parts of the codebase. All usages of CascadingColorRegistry are confined to this file, ensuring that color handling remains consistent across different themes and operating systems.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: List all color-related preferences to help with manual verification

# Test: List all color-related preferences
echo "Color-related preferences:"
rg --type java -i 'color|theme' . | grep -i 'preference\|setting'

# Test: Find usage of CascadingColorRegistry
echo "Usage of CascadingColorRegistry:"
rg --type java 'CascadingColorRegistry'

# Test: Find other places where background colors are set
echo "Other background color settings:"
rg --type java 'setBackground'

Length of output: 5786


Script:

#!/bin/bash
# Description: Find all usages of CascadingColorRegistry and related color settings.

# Find all instances where CascadingColorRegistry is used
echo "Searching for CascadingColorRegistry usages:"
rg --type java 'CascadingColorRegistry'

# Find all files that set background colors using ColorRegistry
echo "Searching for setBackground usages with ColorRegistry:"
rg --type java 'ColorRegistry.*setBackground'

# Find all theme-related color settings across the codebase
echo "Searching for theme-related color settings:"
rg --type java 'theme.*color|ColorConstants'

# Find all preferences related to color settings
echo "Searching for color preference settings:"
rg --type java 'getPreferenceColor|COLOR_'

Length of output: 4327

@AndriiFilippov
Copy link
Collaborator

@sigmaaa hi !

Tested:
OS: Linux 22-09

LGTM 👍

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