[VSC-1578] Modify Event Activation for file types #1568

radurentea · 2025-05-23T11:45:44Z

Removed previous activation events for file types:

"workspaceContains:**/project_description.json",
"workspaceContains:**/sdkconfig",
"workspaceContains:**/CMakeLists.txt"

We only check for CMakeLists.txt at root project folder if it includes "include($ENV{IDF_PATH}/tools/cmake/project.cmake)"

Description

Please include a summary of the change and which issue is fixed.

Fixes #1414

Type of change

Please delete options that are not relevant.

New feature (non-breaking change which adds functionality)

Steps to test this pull request

When opening an ESP-IDF project, the extension should still activate itself (ex: commands from esp-idf should be visible in status bar)
When opening a folder that it's not an esp-idf project there should be two scenarios:
a. If it contains a CMakeLists.txt at the root level which doesn't contain the text include($ENV{IDF_PATH}/tools/cmake/project.cmake) extension should ask, using a notification, if you want to activate esp-idf extension anyway.
b. If it doesn't contain a CMakeLists.txt at all, it should not activate automatically.
This feature should work with workspaces that include multiple esp-idf projects. If at least one of the projects in the workspace contains a valid esp-idf project, the extension should activate itself.

How has this been tested?

As described above

Test Configuration:

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

Checklist

github-actions · 2025-05-23T11:52: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

We need to consider multiple projects scenario.

src/extension.ts

brianignacio5

LGTM

github-actions · 2025-06-19T00:28:56Z

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

Removed previous activation events for file types. We only check for CMakeLists.txt at root project folder if it includes "include($ENV{IDF_PATH}/tools/cmake/project.cmake)"

- No matter the order of the projects, if an idf extension is present, extension will activate itself. - If no idf project is detected, but CMakeLists.txt is detected at root level user is asked if he wants to activate extension

fix: lint issue

If there were folders without CMakeLists.txt file in root, but they had a CMakeLists.txt file in there subfolders, the extension would have activated

Refactored the activation check to search for any CMakeLists.txt in the workspace and verify if it is an ESP-IDF project, rather than only checking root folders. Updated localized messages in Spanish, Portuguese, Russian, and Chinese to reflect the new logic and provide clearer prompts to users.

Fabricio-ESP

Confirmed extension tracks CMakeFiles.txt.
Note file is case sensitive.

brianignacio5

The PR validates CMakeLists.txt only. Using "**/{build,node_modules}/**" seems unnecessary.

brianignacio5 · 2025-07-02T08:21:23Z

src/extension.ts

+  if (PreCheck.isWorkspaceFolderOpen()) {
+    const cmakeListsFiles = await vscode.workspace.findFiles(
+      "**/CMakeLists.txt",
+      "**/{build,node_modules}/**"


Why do we need node_modules? Isn't it from JavaScript Typescript projects ?

The build folder is also used in CMake project or many other kind of projects. The next validation is only for CMakeLists.txt so I'm just wondering why other files are needed here.

The vscode.workspace.findFiles expects as a second argument an exclusion pattern. I just thought it would be good to ignore searching in file such as "node_modules" and "build", if they are present in the opened workspace.

This was the exact thing I wanted to discuss about this new implementation: I can remove the "node_modules" if you think it's unnecessary or add these exclusion patterns for other languages as well, to increase performance of vscode.workspace.findFiles

Oh I see.

Remember that the extension is activated either by running command or "workspaceContains:**/CMakeLists.txt"

Later you can use loop of all workspaceFolders with a relative pattern per workspace folder validation for root only:

const relativePattern = new RelativePattern(workspaceFolderUri, "CMakeLists.txt"); const files = await workspace.findFiles(relativePattern);

The content you are validating is for ESP-IDF root CMakeLists.txt only, so no need to check additional places.

I have changed the implementation once again based on our discussion only needing the CMakeLists.txt from root level. There is no need to use workspace.findFiles() anymore. I've left more details in the commit description

- Replace recursive CMakeLists.txt search with root-only validation - Use direct file system checks instead of workspace.findFiles for better performance - Support multiple workspace folders with ESP-IDF projects at root level - Maintain user prompt for non-ESP-IDF CMakeLists.txt files

brianignacio5

LGTM

radurentea requested a review from brianignacio5 May 23, 2025 11:45

radurentea self-assigned this May 23, 2025

radurentea mentioned this pull request May 23, 2025

Automatically Detect Project Files to Activate ESP-IDF Plugin (VSC-1578) #1414

Closed

brianignacio5 requested changes May 27, 2025

View reviewed changes

src/extension.ts Outdated Show resolved Hide resolved

radurentea requested a review from brianignacio5 May 28, 2025 06:56

brianignacio5 approved these changes Jun 3, 2025

View reviewed changes

radurentea added this to the v1.11.0 milestone Jun 3, 2025

github-actions bot added the stale Stale PR or Issue label Jun 19, 2025

radurentea removed the stale Stale PR or Issue label Jun 20, 2025

radurentea added 5 commits July 1, 2025 18:49

feat: Modify Event Activation for file types

47b3ff4

Removed previous activation events for file types. We only check for CMakeLists.txt at root project folder if it includes "include($ENV{IDF_PATH}/tools/cmake/project.cmake)"

fix: If idf project is detected, activate

88531ed

- No matter the order of the projects, if an idf extension is present, extension will activate itself. - If no idf project is detected, but CMakeLists.txt is detected at root level user is asked if he wants to activate extension

fix: Ignore *.code-profile for linting

159ba4c

fix: lint issue

fix: activation for folder without CMakeLists.txt file

89c2708

If there were folders without CMakeLists.txt file in root, but they had a CMakeLists.txt file in there subfolders, the extension would have activated

radurentea force-pushed the feature/custom-file-type-activation branch from d6ab91c to 254747e Compare July 1, 2025 15:55

Fabricio-ESP self-requested a review July 1, 2025 16:20

Fabricio-ESP approved these changes Jul 1, 2025

View reviewed changes

radurentea requested a review from brianignacio5 July 1, 2025 17:19

brianignacio5 requested changes Jul 2, 2025

View reviewed changes

radurentea requested a review from brianignacio5 July 3, 2025 11:58

brianignacio5 approved these changes Jul 8, 2025

View reviewed changes

radurentea merged commit 3bd2221 into master Jul 8, 2025
6 checks passed

[VSC-1578] Modify Event Activation for file types #1568

[VSC-1578] Modify Event Activation for file types #1568

Uh oh!

Conversation

radurentea commented May 23, 2025

Description

Type of change

Steps to test this pull request

How has this been tested?

Checklist

Uh oh!

github-actions bot commented May 23, 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!

brianignacio5 left a comment

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Jun 19, 2025

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!

brianignacio5 Jul 2, 2025

Choose a reason for hiding this comment

Uh oh!

brianignacio5 Jul 2, 2025

Choose a reason for hiding this comment

Uh oh!

radurentea Jul 2, 2025

Choose a reason for hiding this comment

Uh oh!

brianignacio5 Jul 3, 2025

Choose a reason for hiding this comment

Uh oh!

radurentea Jul 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

brianignacio5 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

github-actions bot commented May 23, 2025 •

edited

Loading

radurentea Jul 3, 2025 •

edited

Loading