search

espressif / idf-eclipse-plugin

Espressif-IDE (based on Eclipse CDT) for ESP-IDF CMake based projects 4.x and above
Eclipse Public License 2.0
302 stars 121 forks source link

feat: improving UX during run/debug #900

Closed sigmaaa closed 7 months ago

sigmaaa commented 7 months ago

Description

This is an alternative to https://github.com/espressif/idf-eclipse-plugin/pull/806, since the approach with filtering run/debug configurations causes bugs and additional maintenance debt

Fixes # (IEP-957)

Type of change

Please delete options that are not relevant.

How has this been tested?

Test 1:

Test Configuration:

Dependent components impacted by this PR:

Checklist

Summary by CodeRabbit

coderabbitai[bot] commented 7 months ago

Walkthrough

The recent update enhances user interaction with debug and launch configurations in the Eclipse environment, focusing on the Espressif IDF UI. It introduces dialogs for selecting configurations, improves messages for better user guidance, and refines execution handling. The shift from asynchronous to synchronous execution in launch target changes ensures more reliable updates, while new classes and properties enhance the user interface and experience.

Changes

File Path Change Summary
.../idf/ui/LaunchBarListener.java Switched from asyncExec to syncExec for handling activeLaunchTargetChanged; updated conditional logic in update method.
.../idf/ui/dialogs/Messages.java, .../idf/ui/handlers/Messages.java, .../idf/ui/dialogs/messages.properties, .../idf/ui/handlers/messages.properties Added new string constants and messages for debug and launch configuration dialogs and handling.
.../idf/ui/dialogs/SelectDebugConfigDialog.java, .../idf/ui/dialogs/SelectLaunchConfigDialog.java Introduced new dialogs for selecting debug and launch configurations.
.../idf/ui/handlers/RunActionHandler.java New class for handling execution events, including launch mode and configuration selection.

🐇✨
In the land of code and wire,
Changes come as needs aspire.
Dialogs bloom like springtime flowers,
Guiding devs through config towers.
Sync and async, hand in hand,
Making launch sequences grand.
🚀🌟

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](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
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 .` - `Generate unit-tests 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 tests 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 tests.` - `@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. - The JSON schema for the configuration file is available [here](https://coderabbit.ai/integrations/coderabbit-overrides.v2.json). - 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/coderabbit-overrides.v2.json` ### CodeRabbit Discord Community Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback.
AndriiFilippov commented 7 months ago

@sigmaaa hi !

Tested under:

OS - Windows 10 ESP-IDF: v5.1.2

🔴 Please, update text with Upper Case for those words and delete extra words.

image

🔴 found a bug related to Launch Config name validation.

Create project A -> create Debug config "A config" -> Edit Debug Config -> Rename to "A" -> there is the warning message only BUT it is still possible to create one. image

If ignore it - in this particular PR it leads to the bug with empty list: image

sigmaaa commented 7 months ago

@sigmaaa hi !

Tested under:

OS - Windows 10 ESP-IDF: v5.1.2

  • Select a debug configuration with Run mode and click "Run" -> Popup appears with suitable launch config -> click launch -> verify functionality 🟢
  • Repeat test 1 for launch configuration with Debug mode 🟢
  • Delete Debug config -> try to debug launch config -> message that suggesting create a debug config 🟢
  • Remove project from debug configuration -> try to launch/debug -> Edit config question provided 🟢
  • Repeated tests with Multiple Launch Configs / Debug Configs 🟢

🔴 Please, update text with Upper Case for those words and delete extra words.

image

🔴 found a bug related to Launch Config name validation.

Create project A -> create Debug config "A config" -> Edit Debug Config -> Rename to "A" -> there is the warning message only BUT it is still possible to create one. image

If ignore it - in this particular PR it leads to the bug with empty list: image

Hi @AndriiFilippov, fixed messages in the latest commit. The empty list bug happens due to editing the configuration name to an existing one, which should not be allowed. It's a bug from Eclipse CDT, I guess and it will be easier to fix on the CDT side

AndriiFilippov commented 7 months ago

@sigmaaa hi !

OK, in this case everything LGTM 👍