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

Docs/update cmds #1160

Merged
merged 7 commits into from
Apr 10, 2024
Merged

Docs/update cmds #1160

merged 7 commits into from
Apr 10, 2024

Conversation

brianignacio5
Copy link
Collaborator

@brianignacio5 brianignacio5 commented Mar 12, 2024

Description

This PR address a few different issues:

  • Rename NVS Partition Editor and Partition Editor commands names.
  • Add button to enable custom partition if disabled when running Partition Editor command. This will update sdkconfig in the back.
  • Add venv validation in Setup Wizard.
  • Pass current workspace folder to setup wizard save settings.

Fixes #1061
Fixes #1086

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)

Steps to test this pull request

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

  1. Click on "NVS Partition Editor" command. Check that names are changed.
  2. Click on "Partition Table Editor" command. Check that names are changed. If custom partition table is not enabled for current project, a notification with a button to enable should appear and if clicked the custom partition table should be enabled in sdkconfig and the partition table editor should appear.
  3. Run ESP-IDF: Configure ESP-IDF extension. Using workspace folder as save settings location (with idf.saveScope).
  4. Use setup wizard in OS without python venv installed. See that the error notification is shown.
  5. Observe results.

How has this been tested?

Manual testing based on steps above.

Test Configuration:

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

Checklist

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

@brianignacio5 brianignacio5 added this to the v1.8.0 milestone Mar 12, 2024
@brianignacio5 brianignacio5 self-assigned this Mar 12, 2024
Copy link

github-actions bot commented Mar 12, 2024

Download the artifacts for this pull request:

Copy link
Collaborator

@radurentea radurentea 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

@brianignacio5 hi !

  1. After clicking "Enable" here

image

the second notification ask to open sdk editor.
image

I think we don't need double confirmation from user.

  1. if you try to open editor without project build, you get notification
    image

but no hint at all here. We could add "Build project first" to this notification as well.

@brianignacio5
Copy link
Collaborator Author

@brianignacio5 hi !

  1. After clicking "Enable" here

image

the second notification ask to open sdk editor. image

I think we don't need double confirmation from user.

  1. if you try to open editor without project build, you get notification
    image

but no hint at all here. We could add "Build project first" to this notification as well.

This should be fixed. PTAL again

@AndriiFilippov
Copy link
Collaborator

@brianignacio5 hi !

Tested under:
OS - Windows 10

After clicking "Enable" here
image

getting this notification
image

esp_idf_vsc_ext.log

@AndriiFilippov
Copy link
Collaborator

@brianignacio5 hi !

Right click on .csv file in project -> The "NVS Partition Editor" still remains in the old format.

image

@brianignacio5
Copy link
Collaborator Author

@brianignacio5 hi !

Right click on .csv file in project -> The "NVS Partition Editor" still remains in the old format.

image

Updated to new format

@AndriiFilippov
Copy link
Collaborator

@brianignacio5 hi !

Run ESP-IDF: Configure ESP-IDF extension. Using workspace folder as save settings location (with idf.saveScope). -> still see the dropdown list during installation

image

@AndriiFilippov
Copy link
Collaborator

@brianignacio5 hi !

Tested under:
OS - Windows 10

Rename NVS Partition Editor and Partition Editor commands names. ✔️
Add button to enable custom partition if disabled when running Partition Editor command. This will update sdkconfig in the back. ✔️
Run ESP-IDF: Configure ESP-IDF extension. Using workspace folder as save settings location (with idf.saveScope). ✔️

If project hasn't built yet -> try to open Partition Table Editor -> good info message 👍
image

LGTM 👍

@brianignacio5 brianignacio5 merged commit 6c544a8 into master Apr 10, 2024
6 checks passed
@brianignacio5 brianignacio5 deleted the docs/update-cmds branch April 10, 2024 09:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
3 participants