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

IEP-1252: Add MenuConfig menu option under ESP-IDF menu list #1052

Closed alirana01 closed 1 week ago

alirana01 commented 1 week ago

Description

Added menuconfig option in ESP-IDF menu list for projects

Fixes # (IEP-1252)

Type of change

Please delete options that are not relevant.

How has this been tested?

Create project and write click to see the Menu Config option in the ESP-IDF context menu and try to launch SDKConfig Editor using that

Test Configuration:

Checklist

Summary by CodeRabbit

coderabbitai[bot] commented 1 week ago

Walkthrough

The pull request introduces several changes to enhance the Espressif IDF SDK configuration UI. A new command is added to the plugin.xml to facilitate access to the MenuConfig editor. Additionally, two public static strings are introduced in the Messages class to handle errors related to the absence of the SDK configuration file. A new class, OpenSdkConfigEditor, is created to manage the opening of the SDK configuration file within the IDE, improving user interaction and error handling.

Changes

File Path Change Summary
bundles/com.espressif.idf.sdk.config.ui/plugin.xml Added a new command for Menu Config with an associated icon and handler.
bundles/com.espressif.idf.sdk.config.ui/src/com/espressif/idf/sdk/config/ui/Messages.java Introduced two public static strings for error messages related to missing SDK configuration files.
bundles/com.espressif.idf.sdk.config.ui/src/com/espressif/idf/sdk/config/ui/OpenSdkConfigEditor.java Created a new class to handle opening the SDK configuration file and checking its existence.
bundles/com.espressif.idf.sdk.config.ui/src/com/espressif/idf/sdk/config/ui/messages.properties Added entries for error messages regarding missing SDK configuration files.

Possibly related PRs

Suggested reviewers

Poem

In the code where rabbits play,
New commands hop in today!
Menu Config, a joyful sight,
Errors handled, all feels right.
With each change, the UI gleams,
Hopping high on coding dreams! 🐇✨

Recent review details **Configuration used: CodeRabbit UI** **Review profile: CHILL**
Commits Files that changed from the base of the PR and between ac7f36b162208ccc2f14bace13d60ec912a94a01 and 68355718d6f31cbda86f3ae32007381a818c6796.
Files selected for processing (4) * bundles/com.espressif.idf.sdk.config.ui/plugin.xml (2 hunks) * bundles/com.espressif.idf.sdk.config.ui/src/com/espressif/idf/sdk/config/ui/Messages.java (1 hunks) * bundles/com.espressif.idf.sdk.config.ui/src/com/espressif/idf/sdk/config/ui/OpenSdkConfigEditor.java (1 hunks) * bundles/com.espressif.idf.sdk.config.ui/src/com/espressif/idf/sdk/config/ui/messages.properties (1 hunks)
Additional comments not posted (8)
bundles/com.espressif.idf.sdk.config.ui/src/com/espressif/idf/sdk/config/ui/messages.properties (2)
`19-19`: **LGTM!** The new property `SDKConfigFileNotFound_ErrorMessage` provides a clear and concise error message when the `sdkconfig` file is missing in the project. The property name follows the naming convention of the file, and the syntax is correct. --- `20-20`: **LGTM!** The new property `SDKConfigurationFileNotFound_Title` provides a short and descriptive title for the error message when the `sdkconfig` file is missing. The property name follows the naming convention of the file, and the syntax is correct.
bundles/com.espressif.idf.sdk.config.ui/src/com/espressif/idf/sdk/config/ui/Messages.java (1)
`30-31`: **LGTM!** The addition of the new string declarations `SDKConfigFileNotFound_ErrorMessage` and `SDKConfigurationFileNotFound_Title` in the `Messages` class is a good enhancement. It aligns with the PR objective of adding a new menu configuration option and improves user experience by providing specific error messages when the SDK configuration file is not found.
bundles/com.espressif.idf.sdk.config.ui/src/com/espressif/idf/sdk/config/ui/OpenSdkConfigEditor.java (3)
`16-63`: **LGTM!** The `OpenSdkConfigEditor` class is well-structured and follows the necessary steps to open the `sdkconfig` file in the editor. The class extends `AbstractHandler` and overrides the `execute` method to handle the execution event. It also includes a private `getCurrentProject` method to retrieve the current project containing the `sdkconfig` file. --- `21-45`: **LGTM!** The `execute` method is well-implemented and handles the necessary steps to open the `sdkconfig` file in the editor. It retrieves the active workbench page and the current project, checks for the existence of the `sdkconfig` file, and takes appropriate actions based on the file's presence. The error handling for `CoreException` is properly implemented, throwing an `ExecutionException` with a descriptive message. --- `47-62`: **LGTM!** The `getCurrentProject` method is well-implemented and correctly retrieves the current project containing the `sdkconfig` file. It iterates through all open projects in the workspace, checks if each project is open and contains the `sdkconfig` file, and returns the first project that meets the criteria. Returning `null` when no project is found is a valid approach, as the calling method (`execute`) handles the case when the current project is `null`.
bundles/com.espressif.idf.sdk.config.ui/plugin.xml (2)
`42-47`: **LGTM!** The new command is correctly defined within the menu contribution. The command ID, icon, label, and style are all appropriately set. --- `57-61`: **Looks good!** The command is correctly defined with a matching ID, appropriate default handler, and a suitable name.
--- 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](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: -- `I pushed a fix in commit , 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 generate interesting stats about this repository and render them as a table.` -- `@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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.