[VSC-1409] Add check for missing compile_commands.json in IDF projects #1271

radurentea · 2024-08-05T13:33:58Z

Description

This pull request adds a new feature to improve the user experience when working with ESP-IDF projects in VS Code, particularly when using the Microsoft C/C++ extension.

Key changes:

Implements a check for the existence of the compile_commands.json file when opening an ESP-IDF project.
If the file is missing, displays a notification to the user with an option to generate it.

For users using the Microsoft's C/C++ compile_commands.json file is crucial for proper IntelliSense functionality in ESP-IDF projects.

JIRA https://jira.espressif.com:8443/browse/VSC-1409

Type of change

New feature (non-breaking change which adds functionality)

Steps to test this pull request

Open an ESP-IDF project that doesn't have a compile_commands.json file in its build directory.
Verify that a notification appears, informing about the missing file and offering to generate it.
Click the "Generate compile_commands.json" button and confirm that it triggers the espIdf.idfReconfigureTask command that generates the compile_command.json file in build folder of the project.

How has this been tested?

As described above

Test Configuration:

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

Checklist

github-actions · 2024-08-05T15:28:58Z

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

Few changes I consider would improve this PR

src/logger/utils.ts

src/extension.ts

radurentea · 2024-08-06T09:48:17Z

Hi @brianignacio5, thank you for the review!
I've made all the modifications, can you please take another look?

brianignacio5

LGTM

radurentea · 2024-08-14T08:35:36Z

Hi @AndriiFilippov, PTAL

github-actions · 2024-08-30T00:21:57Z

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

radurentea · 2024-09-10T08:04:38Z

Hi @Fabricio-ESP, PTAL

github-actions · 2024-09-26T00:23:05Z

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

Fabricio-ESP · 2024-10-01T12:49:54Z

The extension is properly detecting the missing file in the builds folder and running the reconfigure command. Tested on Windows and Linux.

Side effect is that when opening a new project (from a example) the build folder does not exist yet, and the error notification will be triggered. Running the reconfigure command will generate the build for the ESP32 default target. If the user wants to change the target the build folder will need to recreated.

If the user has set multiple configuration profiles and the build folder have other names than "build" the extension is showing the error that the compile_commands.json is missing, but they are properly saved on each build folder, so there is something there to detect the file on this scenario.

src/extension.ts

brianignacio5

LGTM

Fabricio-ESP

Tested on Windows, WSL and Linux.
Reconfigure command working as expected.

- Removed helper function from logger/utils - Moved code in already existing event listener - Wrapped event listener with context.subscriptions.push() - Localized messages displayed to user

We don't need to use "=" in the commands anymore

brianignacio5

Rebase issues.

brianignacio5 · 2024-11-01T08:57:39Z

src/build/buildTask.ts

@@ -129,12 +127,6 @@ export class BuildTask {
          "-DPYTHON_DEPS_CHECKED=1",
          "-DESP_PLATFORM=1",
        ];
-      } else if (useEqualSign) {


The rebase is removing changes from #1266 which are implemented in master.

Please update.

brianignacio5 · 2024-11-01T08:58:07Z

src/espIdf/reconfigure/task.ts

-      reconfigureArgs.push(`-B=${this.buildDirPath}`);
-    } else {
-      reconfigureArgs.push("-B", this.buildDirPath);
+      reconfigureArgs.splice(buildPathArgsIndex, 2);


Same here removing changes in master from #1266

brianignacio5 · 2024-11-01T09:03:31Z

src/extension.ts

@@ -391,77 +392,81 @@ export async function activate(context: vscode.ExtensionContext) {
    binTimestampEventFunc
  );
  context.subscriptions.push(buildWatcherCreateDisposable);
-


Changes from 394 to 469 are not related to the PR proposal solution. While I think is good to add this to context subscription disposable array, the amount of changes are not necessary.

Please update to remove these changes.

radurentea requested a review from brianignacio5 August 5, 2024 13:33

radurentea self-assigned this Aug 5, 2024

brianignacio5 requested changes Aug 6, 2024

View reviewed changes

src/logger/utils.ts Outdated Show resolved Hide resolved

src/extension.ts Outdated Show resolved Hide resolved

src/extension.ts Outdated Show resolved Hide resolved

src/extension.ts Outdated Show resolved Hide resolved

radurentea requested a review from brianignacio5 August 6, 2024 09:48

brianignacio5 approved these changes Aug 14, 2024

View reviewed changes

github-actions bot added the stale Stale PR or Issue label Aug 30, 2024

brianignacio5 removed the stale Stale PR or Issue label Aug 30, 2024

github-actions bot added the stale Stale PR or Issue label Sep 26, 2024

brianignacio5 added this to the 1.9.0 milestone Sep 26, 2024

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 Sep 30, 2024

radurentea force-pushed the enhance/opening-projects-compile-error-solution branch from 5de3252 to f96d071 Compare October 1, 2024 07:45

brianignacio5 requested changes Oct 9, 2024

View reviewed changes

src/extension.ts Show resolved Hide resolved

Fabricio-ESP changed the title ~~Add check for missing compile_commands.json in IDF projects~~ [VSC-1409] Add check for missing compile_commands.json in IDF projects Oct 22, 2024

radurentea requested a review from brianignacio5 October 23, 2024 15:04

radurentea force-pushed the enhance/opening-projects-compile-error-solution branch from a85d68b to c8a4e82 Compare October 25, 2024 07:12

brianignacio5 approved these changes Oct 25, 2024

View reviewed changes

brianignacio5 requested a review from Fabricio-ESP October 25, 2024 08:18

Fabricio-ESP approved these changes Oct 28, 2024

View reviewed changes

radurentea added 4 commits October 28, 2024 14:59

Add check for missing compile_commands.json in IDF projects

e4f0e6c

Set of changes for 1st Code Review

214caa1

- Removed helper function from logger/utils - Moved code in already existing event listener - Wrapped event listener with context.subscriptions.push() - Localized messages displayed to user

Use buildPath param

d298bf6

Remove unnecessary validation

c8f9ec8

We don't need to use "=" in the commands anymore

Fix rebase

0fa8e6c

radurentea force-pushed the enhance/opening-projects-compile-error-solution branch from bf43756 to 0fa8e6c Compare October 28, 2024 13:23

brianignacio5 requested changes Nov 1, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[VSC-1409] Add check for missing compile_commands.json in IDF projects #1271

[VSC-1409] Add check for missing compile_commands.json in IDF projects #1271

radurentea commented Aug 5, 2024

github-actions bot commented Aug 5, 2024 •

edited

Loading

brianignacio5 left a comment

radurentea commented Aug 6, 2024

brianignacio5 left a comment

radurentea commented Aug 14, 2024

github-actions bot commented Aug 30, 2024

radurentea commented Sep 10, 2024

github-actions bot commented Sep 26, 2024

Fabricio-ESP commented Oct 1, 2024 •

edited

Loading

brianignacio5 left a comment

Fabricio-ESP left a comment

brianignacio5 left a comment

brianignacio5 Nov 1, 2024

brianignacio5 Nov 1, 2024

brianignacio5 Nov 1, 2024

[VSC-1409] Add check for missing compile_commands.json in IDF projects #1271

Are you sure you want to change the base?

[VSC-1409] Add check for missing compile_commands.json in IDF projects #1271

Conversation

radurentea commented Aug 5, 2024

Description

Type of change

Steps to test this pull request

How has this been tested?

Checklist

github-actions bot commented Aug 5, 2024 • edited Loading

brianignacio5 left a comment

Choose a reason for hiding this comment

radurentea commented Aug 6, 2024

brianignacio5 left a comment

Choose a reason for hiding this comment

radurentea commented Aug 14, 2024

github-actions bot commented Aug 30, 2024

radurentea commented Sep 10, 2024

github-actions bot commented Sep 26, 2024

Fabricio-ESP commented Oct 1, 2024 • edited Loading

brianignacio5 left a comment

Choose a reason for hiding this comment

Fabricio-ESP left a comment

Choose a reason for hiding this comment

brianignacio5 left a comment

Choose a reason for hiding this comment

brianignacio5 Nov 1, 2024

Choose a reason for hiding this comment

brianignacio5 Nov 1, 2024

Choose a reason for hiding this comment

brianignacio5 Nov 1, 2024

Choose a reason for hiding this comment

github-actions bot commented Aug 5, 2024 •

edited

Loading

Fabricio-ESP commented Oct 1, 2024 •

edited

Loading