[VSC-1541] Enhance/hints viewer openocd #1476

radurentea · 2025-03-14T10:06:02Z

Description

This enhancement:

adds hints for openOCD errors (manual searching using esp-idf hints viewer, search error command)
improves matching for building errors based on automatic/manual searches
adds notification system that will show the user 2 actions when it comes to hints related to building the project
- Focus on the ESP-IDF hints bottom panel
- Mutes "Found Hint" notification for this VS Code session (until VS Code is closed)
adds real-time hints display for openocd errors (when running OpenOCD session, if an error appears and a hint is found for that error, Hints Viewer bottom panel will be focused)
improves hover over errors in text editor (building errors) by increasing the display of the hints when hovering over the entire line where error was found. In the old version, the squiggly line had the length of 1 character. If there were other errors in the same line, for example from C/C++ Extension, it would require luck to find the portion for the ESP-IDF hint to be shown.
Adds extra child for hints in the tree structured data which is clickable (will open the link address in default browser), in case the hint has a link property

Type of change

New feature (non-breaking change which adds functionality)

Steps to test this pull request

Manual searching for errors related to OpenOCD (OpenOCD version needs to be >= v0.12.0-esp32-20250226). List of error-hints pair is taken from:
<ESP_TOOLS_INSTALLATION_PATH>/tools/openocd-esp32/<OPEN_OCD_VERSION>/openocd-esp32/share/openocd/espressif/tools/esp_problems_hints.yml
Manual searching for errors that come from esp-idf's hints yml file, located at <ESP_IDF_INSTALLATION_PATH>/<ESP_IDF_VERSION>/esp-idf/tools/idf_py_actions/hints.yml
Try to reproduce errors from inside both yaml files (esp-idf, openocd) and see if the hints are triggered automatically. The errors from esp-idf should display a notification with 2 actions, while the openocd hints should automatically trigger focus on hints viewer bottom panel
When having errors inside the text editor, post build (for example: adding #include "spiram.h" inside the main.c file of an esp-idf example project), make sure hint is displayed when hovering over the line that has the squiggly lined text

How has this been tested?

As described above

Test Configuration:

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

Checklist

github-actions · 2025-03-14T10:13:21Z

Download the artifacts for this pull request:
You can test these changes by installing this VSIX by click menu View -> Command Palette..., type Install from VSIX and then select downloaded esp-idf-extension.vsix file to install the extension.

esp-idf-extension.vsix.zip
Espressif documentation preview

brianignacio5

Some code suggestions to simplify functionality.

.vscode/settings.json

src/espIdf/hints/index.ts

src/espIdf/hints/openocdhint.ts

github-actions · 2025-04-09T00:26:15Z

Pull request has been marked as stale since there are no activities, and this will be closed in 5 days if there are no further activities

brianignacio5 · 2025-07-03T07:24:53Z

src/extension.ts

    );
  };
+  // Store display hints notification (until VS Code is closed)
+  context.workspaceState.update("idf.showHintsNotification", true);


Why is this state necessary? I don't see being disabled on extension deactivation. Maybe is not necessary ?

The idea behind it was to have a reset of the hints viewer's notifications for each session. I don't remember why I went with this implementation of the Notification System for Hints Viewer.

I've pushed a new commit in which I converted idf.showHintsNotification from runtime workspace state to proper configurable setting that will persist in workspace settings

brianignacio5

LGTM without using the workspaceState setting, which doesn't seem to be configurable.

brianignacio5

Missing translation and documentation of new setting.

package.json

brianignacio5

LGTM

Fabricio-ESP

Confirmed working.
Thanks for the change on how the hints are displayed.

brianignacio5

Please review existing status bar items implementation and use of registerIDFCommand instead of vscode.commands.registerCommand

src/extension.ts

src/statusBar/index.ts

src/extension.ts

brianignacio5

LGTM with minor change regarding code organization.

src/statusBar/index.ts

- Refactor code - Add Translations

- fix errors related to errorHints view

- change === to includes - remove checking for openOCD hints, hints from openocd will not be present in text editor

Before this fix, if there were multiple hints matches, there would be multiple notifications

Convert idf.showHintsNotification from runtime workspace state to proper configurable setting

Added validation for checking if any workspace is open

Fix lint

- Add translations for new hints viewer status bar item implementation - Remove translation from old notification system for hints viewer - Clean some unnecessary comments

- Move hints status bar creation to createCmdsStatusBarItems function - Change id from "idfErrorHints" to "espIdf.errorHints" - Use "registerIDFCommand" instead of "vscode.commands.registerCommand"

radurentea self-assigned this Mar 14, 2025

radurentea requested a review from brianignacio5 March 14, 2025 10:46

brianignacio5 requested changes Mar 24, 2025

View reviewed changes

.vscode/settings.json Outdated Show resolved Hide resolved

src/espIdf/hints/index.ts Outdated Show resolved Hide resolved

src/espIdf/hints/index.ts Outdated Show resolved Hide resolved

src/espIdf/hints/openocdhint.ts Show resolved Hide resolved

github-actions bot added the stale Stale PR or Issue label Apr 9, 2025

github-actions bot closed this Apr 14, 2025

radurentea added ongoing Ongoing Issue or PR, this label will be used for issue or PR which is to be excluded by stale bot and removed stale Stale PR or Issue labels Apr 15, 2025

radurentea reopened this Apr 15, 2025

brianignacio5 requested a review from Fabricio-ESP May 7, 2025 08:32

radurentea force-pushed the enhance/hints-viewer-openocd branch from 675b284 to 65efe87 Compare May 7, 2025 14:07

radurentea requested a review from brianignacio5 May 7, 2025 14:08

radurentea force-pushed the enhance/hints-viewer-openocd branch from f3793f8 to 57799e8 Compare May 9, 2025 08:53

radurentea added this to the v1.11.0 milestone May 19, 2025

radurentea force-pushed the enhance/hints-viewer-openocd branch from 57799e8 to 10c0173 Compare July 3, 2025 04:37

radurentea removed the ongoing Ongoing Issue or PR, this label will be used for issue or PR which is to be excluded by stale bot label Jul 3, 2025

brianignacio5 reviewed Jul 3, 2025

View reviewed changes

brianignacio5 approved these changes Jul 3, 2025

View reviewed changes

radurentea requested a review from brianignacio5 July 3, 2025 13:26

radurentea force-pushed the enhance/hints-viewer-openocd branch from bcbd569 to 33c0402 Compare July 3, 2025 13:29

brianignacio5 requested changes Jul 8, 2025

View reviewed changes

package.json Outdated Show resolved Hide resolved

package.json Outdated Show resolved Hide resolved

radurentea force-pushed the enhance/hints-viewer-openocd branch from d8d4fe9 to 8f4b8bc Compare July 11, 2025 07:46

brianignacio5 approved these changes Jul 11, 2025

View reviewed changes

Fabricio-ESP approved these changes Jul 18, 2025

View reviewed changes

Fabricio-ESP changed the title ~~Enhance/hints viewer openocd~~ [VSC-1541] Enhance/hints viewer openocd Jul 22, 2025

brianignacio5 requested changes Jul 24, 2025

View reviewed changes

src/extension.ts Outdated Show resolved Hide resolved

src/statusBar/index.ts Outdated Show resolved Hide resolved

src/extension.ts Outdated Show resolved Hide resolved

src/extension.ts Outdated Show resolved Hide resolved

radurentea force-pushed the enhance/hints-viewer-openocd branch from 997eb9c to 8501057 Compare July 30, 2025 08:08

radurentea requested review from Fabricio-ESP and brianignacio5 July 30, 2025 09:00

brianignacio5 approved these changes Jul 31, 2025

View reviewed changes

src/statusBar/index.ts Show resolved Hide resolved

Fabricio-ESP approved these changes Jul 31, 2025

View reviewed changes

radurentea added 25 commits August 4, 2025 10:54

Add identification of problems

fffce90

Add focus when hint found; Improve hintsviewer

f5f5746

Add openocd hints

3a48f3d

Refactor code; Remove partial matches

2c7bc1d

Remove notification

6e19482

Add openOCD automatic search for hints

f30fb09

improve: Display clickable links

3bf40d2

Add button to clear hints

10cfe12

- Refactor code - Add Translations

Add openocd version validation for hints

5978c7e

Fix regex for build errors

320e0de

- fix errors related to errorHints view

Fix search for openOCD hints

15b4d3b

Fix parsing inside loadHints

61a9412

Fix hints on hover

bda5aa2

- change === to includes - remove checking for openOCD hints, hints from openocd will not be present in text editor

Replace autofocus for build hints to notification

5885abb

Add translations

497fd7c

fix: remove personal .vscode settings

0a4aa01

fix: duplicate function getOpenOcdHintsYmlPath

a6dd142

fix: display one generic notification

87cd5ac

Before this fix, if there were multiple hints matches, there would be multiple notifications

feat: make hints notification setting configurable and persistent

5ba3d3e

Convert idf.showHintsNotification from runtime workspace state to proper configurable setting

Fix translation

8b5a971

Add new idf.showHintsNotification in documentation

5f19a9a

fix: error when no workspace is open

a8b7be4

Added validation for checking if any workspace is open

Replace notifications with status bar item

d979543

Fix lint

Fix translations

92dcc58

- Add translations for new hints viewer status bar item implementation - Remove translation from old notification system for hints viewer - Clean some unnecessary comments

refactor: integrate hints status bar item with main status bar system

364a879

- Move hints status bar creation to createCmdsStatusBarItems function - Change id from "idfErrorHints" to "espIdf.errorHints" - Use "registerIDFCommand" instead of "vscode.commands.registerCommand"

radurentea force-pushed the enhance/hints-viewer-openocd branch from 8501057 to 364a879 Compare August 4, 2025 07:56

radurentea merged commit 1bd4dbe into master Aug 18, 2025
6 checks passed

[VSC-1541] Enhance/hints viewer openocd #1476

[VSC-1541] Enhance/hints viewer openocd #1476

Uh oh!

Conversation

radurentea commented Mar 14, 2025

Description

Type of change

Steps to test this pull request

How has this been tested?

Checklist

Uh oh!

github-actions bot commented Mar 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

brianignacio5 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Apr 9, 2025

Uh oh!

brianignacio5 Jul 3, 2025

Choose a reason for hiding this comment

Uh oh!

radurentea Jul 3, 2025

Choose a reason for hiding this comment

Uh oh!

radurentea Jul 3, 2025

Choose a reason for hiding this comment

Uh oh!

brianignacio5 left a comment

Choose a reason for hiding this comment

Uh oh!

brianignacio5 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

brianignacio5 left a comment

Choose a reason for hiding this comment

Uh oh!

Fabricio-ESP left a comment

Choose a reason for hiding this comment

Uh oh!

brianignacio5 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

brianignacio5 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

github-actions bot commented Mar 14, 2025 •

edited

Loading