idf-eclipse-plugin icon indicating copy to clipboard operation
idf-eclipse-plugin copied to clipboard

IEP-1498 Clean-up extensions in the ui plugin

Open sigmaaa opened this issue 7 months ago • 1 comments

Description

Group menus, commands, and handlers for better visibility

Was: image

Now: image

Fixes # (IEP-1498)

Type of change

Please delete options that are not relevant.

  • New feature (non-breaking change which adds functionality)

How has this been tested?

Verify that all commands in all menus work

Test Configuration:

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

Dependent components impacted by this PR:

  • Menus and Commands

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

    • Introduced an enhanced main menu with new commands for tool management, project/component creation, memory and heap analysis, component installation, flash operations, documentation access, and language settings.
    • Added dynamic submenus and improved menu organization for easier navigation.
    • Expanded command support with refined visibility and activation conditions based on project context.
  • Refactor

    • Reorganized and consolidated menu, command, and handler structures for a more integrated and user-friendly UI experience.

sigmaaa avatar Apr 28 '25 09:04 sigmaaa

Walkthrough

The plugin.xml file for the Eclipse plugin was extensively reorganized and expanded. Menu, command, and handler definitions were consolidated and restructured, with new commands, handlers, and menu contributions added for various ESP-IDF-related actions. The changes introduce a dedicated Espressif main menu with dynamic submenus and refined visibility conditions. Command declarations and their handler mappings were updated, new command categories were introduced, and wizard and perspective extensions were moved and clarified. Some redundant or duplicate definitions were removed, and property tester extensions were repositioned for clarity.

Changes

File(s) Change Summary
bundles/com.espressif.idf.ui/plugin.xml - Reorganized and consolidated menu, command, and handler definitions.
- Added new "espressifMenu" with multiple commands and dynamic submenus.
- Introduced new command category and expanded command declarations for project, component, memory analysis, erase flash, help, SBOM, and more.
- Added and updated handler mappings with new and existing handler classes.
- Refined visibility and activation conditions for menu items and handlers.
- Moved and clarified new project/component wizards, perspective extensions, and import wizards.
- Removed redundant/duplicate extensions and repositioned property tester extension.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant EclipseUI
    participant EspressifMenu
    participant CommandHandler

    User->>EclipseUI: Open Espressif menu
    EclipseUI->>EspressifMenu: Display menu items (commands, submenus)
    User->>EspressifMenu: Select a command (e.g., New Project)
    EspressifMenu->>CommandHandler: Invoke associated handler
    CommandHandler->>EclipseUI: Execute command action (e.g., open wizard, run tool)

Possibly related PRs

  • espressif/idf-eclipse-plugin#1108: Modifies the NewProjectCreationWizardPage UI class; both PRs relate to the new project wizard, with this PR focusing on plugin.xml configuration and #1108 on UI layout.

Suggested reviewers

  • AndriiFilippov
  • kolipakakondal
  • alirana01

Poem

In the warren of menus, a new path appears,
With commands for projects, components, and cheers!
Wizards and handlers, all neatly aligned,
Espressif’s menu—so easy to find.
Hop, skip, and jump, through UI delight,
This plugin hops forward, both tidy and bright!
🐇✨


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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 generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in 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 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.

coderabbitai[bot] avatar Apr 28 '25 09:04 coderabbitai[bot]

@sigmaaa @kolipakakondal hi !

Tested under: OS - Windows 11 ESP-IDF: master

Visibility ✅ Enablement ✅ Execution Label Icon✅ Localization✅

LGTM 👍

@kolipakakondal yes, tests cover some cases and fails in case of issues in the file menus, but not all of them. have created a task to cover this behavior

AndriiFilippov avatar Jun 05 '25 07:06 AndriiFilippov