IEP-1198 Unclear message when another ESP-IDF path is found

[sigmaaa]

Description

Make warning message when different IDF version is detected in esp-idf.json more intuitive
Fixes # (IEP-1198)

Type of change

Please delete options that are not relevant.

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

How has this been tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

• Test A
• Test B

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
  • Improved messaging for ESP-IDF path configuration, offering clearer instructions and options to users.
• Refactor
  • Enhanced code readability and maintainability in tool initialization processes.

[coderabbitai]

Walkthrough

This update introduces clearer user instructions and options for handling different ESP-IDF paths, alongside code refactoring for better readability and maintenance. It enhances the user experience by providing explicit choices when a discrepancy in ESP-IDF paths is detected, ensuring a smoother setup process.

Changes

File Path	Change Summary
.../idf.core/src/.../Messages.java	Added ToolsInitializationDifferentPathMessageBoxOptionYes and ToolsInitializationDifferentPathMessageBoxOptionNo.
.../idf.core/src/.../messages.properties	Updated message for ESP-IDF path discrepancy with clearer instructions.
.../idf.ui/src/.../InitializeToolsStartup.java	Enhanced message box with Map.of for button labels, adjusted method parameters, and refactored code formatting.

Possibly related issues

• getting 13 semantic error while building "Hello World" in idf-eclipse plugin in ubuntu. (IEP-970) #777: The semantic errors and unresolved symbols/types in the "Hello World" example might not be directly addressed by the UI and message improvements in this PR, but ensuring the correct ESP-IDF path could indirectly mitigate environment setup issues that lead to such errors. Hence, this PR could be a step towards resolving environment configuration problems highlighted in the issue.

🎉🐰✨
A hop, a skip, in the code we dip,
Paths once tangled, now clearly clipped.
With buttons bright and options clear,
Setup woes, we no longer fear.
For every coder, rabbit, and sprite,
This update makes our IDE light.
✨🐰🎉

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

• X
• Mastodon
• Reddit
• LinkedIn

---

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

[coderabbitai]

Actionable comments posted: 0

Review Status

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between cd49fcf and 455d404.

Files selected for processing (3)

• bundles/com.espressif.idf.core/src/com/espressif/idf/core/build/Messages.java (1 hunks)
• bundles/com.espressif.idf.core/src/com/espressif/idf/core/build/messages.properties (1 hunks)
• bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/InitializeToolsStartup.java (5 hunks)

Additional comments not posted (9)

bundles/com.espressif.idf.core/src/com/espressif/idf/core/build/Messages.java (2)

32-32: The addition of ToolsInitializationDifferentPathMessageBoxOptionYes enhances clarity in user options. Good job.

---

33-33: The addition of ToolsInitializationDifferentPathMessageBoxOptionNo is a clear way to present options to the user. Well done.

bundles/com.espressif.idf.core/src/com/espressif/idf/core/build/messages.properties (3)

22-22: Updating the message to specify the configuration file and provide clear instructions improves user understanding. Nicely done.

---

23-23: Adding a clear affirmative option (Use New Path) for the user is a thoughtful touch.

---

24-24: Adding a clear negative option (Use Old Path) for the user enhances decision-making. Good addition.

bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/InitializeToolsStartup.java (4)

15-15: The addition of the java.util.Map import supports the use of Map.of for setting button labels. This is a necessary change.

---

119-120: Using Map.of for setting button labels is a clean and modern approach. This enhances code readability and maintainability.

---

128-129: The adjustments in method call parameters for updateEspIdfJsonFile are correctly aligned with the changes made in the message box options. This ensures consistency in user choices.

---

119-129: The code formatting changes, including the use of Map.of and adjustments in method call parameters, contribute positively to the code's readability and maintainability.

[kolipakakondal]

LGTM