Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature/hints viewer v2 #1225

Merged
merged 2 commits into from
Jun 25, 2024
Merged

Feature/hints viewer v2 #1225

merged 2 commits into from
Jun 25, 2024

Conversation

radurentea
Copy link
Collaborator

Description

Added Hints Viewer. Hints are provided in yaml file from esp-idf folder: /tools/idf_py_actions/hints.yml
There is a bottom panel now called "ESP-IDF" which displays the hints and errors automatically based on the issues the user current have in the file that he has open in text editor. There is also a button which user can use for manual searches.
User can also see the hints if he hovers over the red squiggly lines in the text editor.

This is the same implementation as in #1031, but created another PR because the branch was too old and had too many conflicts to solve.

Type of change

Please delete options that are not relevant.

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

Steps to test this pull request

Provide a list of steps to test changes in this PR and required output

  1. Open ERROR HINTS bottom panel:
    image

  2. Press on "ESP-IDF: Search Error Hint"
    image

  3. Paste error in the top input that shows up
    image

  • Expected behaviour:
    Hints shown in the panel
    image

How has this been tested?

Followed the steps above on a windows OS.

Test Configuration:

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

Checklist

  • PR Self Reviewed
  • Applied Code formatting
  • Added Documentation
  • Added Unit Test
  • Verified on all platforms - Windows,Linux and macOS

Added full implementation of hints viewer
@radurentea
Copy link
Collaborator Author

@brianignacio5 and @AndriiFilippov PTAL

Copy link

Download the artifacts for this pull request:

Copy link
Collaborator

@brianignacio5 brianignacio5 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@AndriiFilippov
Copy link
Collaborator

@radurentea hi !

Create a "Hello World" project -> add string [#import "spiram.h"] -> build -> get error "spiram.h: No such file or directory" -> call "ESP-IDF: Focus on Error Hints View" " -> execute hint search automatically -> able to see hints ✔️

image

LGTM 👍

Have a couple of thoughts:

  1. since ESP-IDF: Focus on Error Hints View search for hints automatically, why do we need ESP-IDF: Search Error Hint ??

  2. Feature seems nice, but it is like a bit hidden from user. Maybe should we add icon to Tool Bar , or maybe something else ?
    or even link to execute ESP-IDF: Focus on Error Hints View somewhere here ?

image

@radurentea
Copy link
Collaborator Author

1.since ESP-IDF: Focus on Error Hints View search for hints automatically, why do we need ESP-IDF: Search Error Hint ??

  • That was the first implementation and I've just kept it, maybe there is some use for some users.

2.Feature seems nice, but it is like a bit hidden from user...

  • I think we can add it to the Walkthrough we've discussed and/or create a list of features where we can display it in the documentation / welcome page

We can create a ticket for improvement to keep track of your feedback and maybe in the future we will also receive some feedback from the users.

@radurentea radurentea merged commit 2fdf463 into master Jun 25, 2024
6 checks passed
@radurentea radurentea mentioned this pull request Jun 26, 2024
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants