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 #1031

Closed
wants to merge 17 commits into from
Closed

Feature/hints viewer #1031

wants to merge 17 commits into from

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

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

@radurentea radurentea self-assigned this Aug 31, 2023
@github-actions
Copy link

github-actions bot commented Sep 12, 2023

Download the artifacts for this pull request:

@kolipakakondal kolipakakondal added this to the v1.7.0 milestone Sep 14, 2023
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.

Few changes I think is need to make sure the code doesn't break like file exists and IDF version validation.

src/espIdf/hints/index.ts Outdated Show resolved Hide resolved
Add validations for:
- file exist
- yaml format
- esp-idf version >= 5.0
@AndriiFilippov
Copy link
Collaborator

@radurentea hi !

Tested:
OS - Windows 10
ESP-IDF: v5.1.1

  1. Create a "Hello World" project -> add string [#import "spiram.h"] -> build -> get error "spiram.h: No such file or directory" -> call "ESP-IDF: Search Error Hint" -> paste error message -> could not find error hint:
    image

  2. I don't understand the purpose of command "ESP-IDF: Focus on Error Hints View". I mean the Error Hint View opens automatically once user use command "ESP-IDF: Search Error Hint". So, I don't know if this is useful feature.

@github-actions
Copy link

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

@github-actions github-actions bot added the stale Stale PR or Issue label Oct 13, 2023
@radurentea radurentea removed the stale Stale PR or Issue label Oct 16, 2023
@radurentea
Copy link
Collaborator Author

Hi @AndriiFilippov,

  1. Fixed the searching issue. Also, fixed an issue where if you would search directly from the Command Palette the Hints Panel wouldn't focus. (For example, if in your bottom panel you had Terminal opened).

  2. That command is added automatically by VS Code for new views. I can't change it's behaviour

Copy link

github-actions bot commented Nov 3, 2023

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

@github-actions github-actions bot added the stale Stale PR or Issue label Nov 3, 2023
@github-actions github-actions bot closed this Nov 8, 2023
@radurentea 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 Nov 8, 2023
@radurentea radurentea reopened this Nov 8, 2023
@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: Search Error Hint" -> paste error message -> able to see hints
image

command "ESP-IDF: Focus on Error Hints View" works fine 👍

LGTM 👍

@brianignacio5 brianignacio5 removed this from the v1.7.0 milestone Jan 24, 2024
@kolipakakondal kolipakakondal added this to the v1.8.0 milestone Feb 5, 2024
@brianignacio5 brianignacio5 removed this from the v1.8.0 milestone May 22, 2024
- Now the hints update accordingly when changing files
- Not focusing the hints viewer bottom panel if no hints found
@radurentea radurentea mentioned this pull request Jun 20, 2024
5 tasks
@radurentea
Copy link
Collaborator Author

Closing this PR because I've re-implemented this here: #1225

The reason is that the branch is too old and there are too many conflicts to solve.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ongoing Ongoing Issue or PR, this label will be used for issue or PR which is to be excluded by stale bot
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants