Fix ${workspaceFolder} expansion in cmake.additionalCompilerSearchDirs for single-root workspaces (#4822)

* Initial plan

* Fix ${workspaceFolder} expansion in additionalCompilerSearchDirs for single-root workspaces (#4571)

Co-authored-by: Omotola <[email protected]>

* Revert multiroot changes and apply simpler fix

Co-authored-by: Omotola <[email protected]>
Agent-Logs-Url: https://github.com/microsoft/vscode-cmake-tools/sessions/fb47d979-7034-47d4-b72f-0906f68d7e6d

* fixed the npmrc file being renamed

---------

Co-authored-by: copilot-swe-agent[bot] <[email protected]>
Co-authored-by: Omotola <[email protected]>
Co-authored-by: Omotola <[email protected]>
Co-authored-by: Hannia Valera <[email protected]>
Co-authored-by: Hannia Valera <[email protected]>

Author: 4 people

CHANGELOG.md

@@ -31,6 +31,8 @@ Improvements:
 - Honor `debugger.workingDirectory` from the CMake File API when debugging a target, so that the `DEBUGGER_WORKING_DIRECTORY` target property is used as the debugger working directory. [#4595](https://github.com/microsoft/vscode-cmake-tools/issues/4595)
 
 Bug Fixes:
+- Fix `cmake.additionalCompilerSearchDirs` ignoring per-folder overrides in multiroot workspaces. The setting is now read from each folder's scoped configuration with `${workspaceFolder}` expanded per-folder, and the results are unioned. Also fix `cmake.cmakePath` resolution during kit scanning to try all workspace folders instead of only the first.
+- Fix `${workspaceFolder}` expansion in `cmake.additionalCompilerSearchDirs` for single-root workspaces. Previously only the multi-root `${workspaceFolder:name}` syntax worked. [#4571](https://github.com/microsoft/vscode-cmake-tools/issues/4571)
 - Fix `cmake.revealLog` set to `"focus"` not revealing the output panel or stealing focus. The output channel now correctly appears and takes focus on both configure success and failure when this setting is used. [#4471](https://github.com/microsoft/vscode-cmake-tools/issues/4471)
 - Fix `${command:cmake.selectConfigurePreset}` (and other preset/kit selection commands) failing with "command did not return a result of type string" when used in `tasks.json` as a command variable. The commands now return the selected preset or kit name instead of a boolean. [#4239](https://github.com/microsoft/vscode-cmake-tools/issues/4239)
 - Fix renaming a CMake project creating a duplicate node in the Project Outline instead of replacing the existing one. [#4343](https://github.com/microsoft/vscode-cmake-tools/issues/4343)

docs/cmake-settings.md

@@ -8,7 +8,7 @@ Options that support substitution, in the table below, allow variable references
 
 | Setting  | Description | Default value | Supports substitution |
 |---------|---------|---------|-----|
-| `cmake.additionalCompilerSearchDirs`| List of paths to search for additional compilers, like a MinGW installation. This means that GCC does not need to be on your `$PATH` for it to be found via kit scanning. For example: `["C:\\MinGW\\bin"]` (Search in C:\MinGW\bin for a MinGW installation) | `[]` | no |
+| `cmake.additionalCompilerSearchDirs`| List of paths to search for additional compilers, like a MinGW installation. This means that GCC does not need to be on your `$PATH` for it to be found via kit scanning. For example: `["C:\\MinGW\\bin"]` (Search in C:\MinGW\bin for a MinGW installation) | `[]` | yes |
 | `cmake.additionalKits` | Array of paths to custom kit files. These are in addition to the default kit files. | `[]` | no |
 | `cmake.allowCommentsInPresetsFile` | Allow the use of JSON extensions such as comments in CMakePresets.json. Please note that your CMakePresets.json file may be considered invalid by other IDEs or on the command line if you use non-standard JSON. | `false` | no |
 | `cmake.allowUnsupportedPresetsVersions` | Enables the use of presets files that are using features from the versions that Cmake Tools extension doesn't currently support. Unknown properties and macros will be ignored. | `false` | no |

src/config.ts

@@ -547,12 +547,23 @@ export class ConfigurationReader implements vscode.Disposable {
     }
 
     get additionalCompilerSearchDirs(): string[] {
+        return ConfigurationReader.getAdditionalCompilerSearchDirsFromConfig(this.configData);
+    }
+
+    /**
+     * Extract additionalCompilerSearchDirs from raw config data, applying the
+     * mingwSearchDirs deprecation fallback.  This is intentionally static so
+     * callers that only have an `ExtensionConfigurationSettings` object (e.g.
+     * the multiroot aggregation in extension.ts) can reuse the logic without
+     * constructing a full ConfigurationReader.
+     */
+    static getAdditionalCompilerSearchDirsFromConfig(configData: ExtensionConfigurationSettings): string[] {
         // mingwSearchDirs is deprecated, but we still use it if additionalCompilerSearchDirs is not set for backwards compatibility
-        if (this.configData.additionalCompilerSearchDirs.length === 0 && this.configData.mingwSearchDirs.length > 0) {
+        if (configData.additionalCompilerSearchDirs.length === 0 && configData.mingwSearchDirs.length > 0) {
             log.warning(localize('please.upgrade.configuration', 'The setting {0} is replaced by {1}. Please upgrade your configuration.', '"mingwSearchDirs"', '"additionalCompilerSearchDirs"'));
-            return this.configData.mingwSearchDirs;
+            return configData.mingwSearchDirs;
         }
-        return this.configData.additionalCompilerSearchDirs;
+        return configData.additionalCompilerSearchDirs;
     }
     get additionalKits(): string[] {
         return this.configData.additionalKits;

src/extension.ts

@@ -1061,8 +1061,19 @@ export class ExtensionManager implements vscode.Disposable {
         if (!vscode.workspace.workspaceFolders || vscode.workspace.workspaceFolders.length < 1) {
             return;
         }
-        const workspaceContext = DirectoryContext.createForDirectory(vscode.workspace.workspaceFolders[0], new StateManager(this.extensionContext, vscode.workspace.workspaceFolders[0]));
-        const cmakePath: string = await workspaceContext.getCMakePath() || '';
+
+        // Resolve the cmake path from workspace folders.  In a multiroot workspace different
+        // folders may configure different cmake.cmakePath values; try each folder and use the
+        // first one that resolves to a non-empty path.
+        let cmakePath = '';
+        for (const folder of vscode.workspace.workspaceFolders) {
+            const workspaceContext = DirectoryContext.createForDirectory(folder, new StateManager(this.extensionContext, folder));
+            cmakePath = await workspaceContext.getCMakePath() || '';
+            if (cmakePath) {
+                break;
+            }
+        }
+
         const duplicateRemoved = await KitsController.scanForKits(cmakePath);
         if (duplicateRemoved) {
             // Check each project. If there is an active kit set and if it is of the old definition, unset the kit.
@@ -1079,38 +1090,60 @@ export class ExtensionManager implements vscode.Disposable {
     }
 
     /**
-     * Get the current additional compiler search directories, like MinGW directories
+     * Get the current additional compiler search directories, like MinGW directories.
+     * In multiroot workspaces, reads the setting from each folder's scoped configuration
+     * and expands ${workspaceFolder} per-folder, returning the union of all directories.
      */
     private async getAdditionalCompilerDirs(): Promise<string[]> {
-        const optsVars: KitContextVars = {
-            userHome: paths.userHome,
-
-            // This is called during scanning for kits, which is an operation that happens
-            // outside the scope of a project folder, so it doesn't need the below variables.
-            buildKit: "",
-            buildType: "",
-            generator: "",
-            workspaceFolder: "",
-            workspaceFolderBasename: "",
-            workspaceHash: "",
-            workspaceRoot: "",
-            workspaceRootFolderName: "",
-            buildKitVendor: "",
-            buildKitTriple: "",
-            buildKitVersion: "",
-            buildKitHostOs: "",
-            buildKitTargetOs: "",
-            buildKitTargetArch: "",
-            buildKitVersionMajor: "",
-            buildKitVersionMinor: "",
-            projectName: "",
-            sourceDir: ""
-        };
         const result = new Set<string>();
-        for (const dir of this.workspaceConfig.additionalCompilerSearchDirs) {
-            const expandedDir: string = util.lightNormalizePath(await expandString(dir, { vars: optsVars }));
-            result.add(expandedDir);
+        const folders = vscode.workspace.workspaceFolders ?? [];
+
+        // Collect (folder, dirs) pairs from all workspace folders.
+        // Each folder may have its own cmake.additionalCompilerSearchDirs override.
+        const folderDirPairs: { folderPath: string; dirs: string[] }[] = [];
+        if (folders.length === 0) {
+            // No workspace folders — fall back to the extension-level config
+            folderDirPairs.push({ folderPath: '', dirs: this.workspaceConfig.additionalCompilerSearchDirs });
+        } else {
+            for (const folder of folders) {
+                const folderConfig = ConfigurationReader.loadConfig(folder);
+                const dirs = ConfigurationReader.getAdditionalCompilerSearchDirsFromConfig(folderConfig);
+                folderDirPairs.push({ folderPath: folder.uri.fsPath, dirs });
+            }
+        }
+
+        for (const { folderPath, dirs } of folderDirPairs) {
+            const optsVars: KitContextVars = {
+                userHome: paths.userHome,
+
+                // This is called during scanning for kits, which is an operation that happens
+                // outside the scope of a project folder, so it doesn't need most of the below variables.
+                // workspaceFolder is populated so that ${workspaceFolder} can be used in additionalCompilerSearchDirs.
+                buildKit: "",
+                buildType: "",
+                generator: "",
+                workspaceFolder: folderPath,
+                workspaceFolderBasename: folderPath ? path.basename(folderPath) : "",
+                workspaceHash: folderPath ? util.makeHashString(folderPath) : "",
+                workspaceRoot: folderPath,
+                workspaceRootFolderName: folderPath ? path.basename(folderPath) : "",
+                buildKitVendor: "",
+                buildKitTriple: "",
+                buildKitVersion: "",
+                buildKitHostOs: "",
+                buildKitTargetOs: "",
+                buildKitTargetArch: "",
+                buildKitVersionMajor: "",
+                buildKitVersionMinor: "",
+                projectName: "",
+                sourceDir: ""
+            };
+            for (const dir of dirs) {
+                const expandedDir: string = util.lightNormalizePath(await expandString(dir, { vars: optsVars }));
+                result.add(expandedDir);
+            }
         }
+
         return Array.from(result);
     }