Fix select preset/kit commands to return strings for task variable substitution (#4825)

* Initial plan

* fix: return preset/kit name instead of boolean from select commands

The select commands (selectConfigurePreset, selectBuildPreset,
selectTestPreset, selectPackagePreset, selectWorkflowPreset, selectKit)
now return the selected preset/kit name as a string instead of a boolean.
This allows them to work correctly as ${command:...} variables in
tasks.json, which require a string result.

Empty string is returned on cancellation (falsy), so all existing
callers that check truthiness continue to work correctly.

Fixes #4239

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

* Fix merge conflict markers in CHANGELOG.md

Co-authored-by: hanniavalera <[email protected]>
Agent-Logs-Url: https://github.com/microsoft/vscode-cmake-tools/sessions/7e265975-65ca-40bf-87fc-2d06d58ae0a5

---------

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]>

Author: 3 people

CHANGELOG.md

@@ -31,6 +31,7 @@ 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 `${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)
 - Remove internal stack traces from the Output pane when a subprocess fails. Error messages now show only human-readable information; stack traces are still available in debug-level logging. [#4807](https://github.com/microsoft/vscode-cmake-tools/issues/4807)
 - Fix duplicate launch configurations in the ctest debug picker when both `.vscode/launch.json` and a `.code-workspace` file exist. [#4586](https://github.com/microsoft/vscode-cmake-tools/issues/4586)

src/extension.ts

@@ -1121,15 +1121,15 @@ export class ExtensionManager implements vscode.Disposable {
     /**
     * Show UI to allow the user to select an active kit
     */
-    async selectKit(folder?: vscode.WorkspaceFolder): Promise<boolean> {
+    async selectKit(folder?: vscode.WorkspaceFolder): Promise<string> {
         if (util.isTestMode()) {
             log.trace(localize('selecting.kit.in.test.mode', 'Running CMakeTools in test mode. selectKit is disabled.'));
-            return false;
+            return '';
         }
 
         const cmakeProject = this.getProjectsForWorkspaceFolder(folder);
         if (!cmakeProject) {
-            return false;
+            return '';
         }
 
         const activeProject = this.getActiveProject();
@@ -1159,11 +1159,7 @@ export class ExtensionManager implements vscode.Disposable {
             telemetry.logEvent('kitSelection', telemetryProperties);
         }
 
-        if (kitSelected) {
-            return true;
-        }
-
-        return false;
+        return kitSelected ? activeKit?.name ?? '' : '';
     }
 
     /**
@@ -2166,20 +2162,20 @@ export class ExtensionManager implements vscode.Disposable {
     /**
      * Show UI to allow the user to select an active configure preset
      */
-    async selectConfigurePreset(folder?: vscode.WorkspaceFolder): Promise<boolean> {
+    async selectConfigurePreset(folder?: vscode.WorkspaceFolder): Promise<string> {
         if (util.isTestMode()) {
             log.trace(localize('selecting.config.preset.in.test.mode', 'Running CMakeTools in test mode. selectConfigurePreset is disabled.'));
-            return false;
+            return '';
         }
 
         const project = this.getProjectFromFolder(folder);
         if (!project) {
-            return false;
+            return '';
         }
 
         if (!project.useCMakePresets) {
             log.info(localize('skip.set.configure.preset', 'Using kits, skip selecting configure preset'));
-            return false;
+            return '';
         }
 
         const presetSelected = await project.presetsController.selectConfigurePreset();
@@ -2191,7 +2187,7 @@ export class ExtensionManager implements vscode.Disposable {
         this.statusBar.setBuildPresetName(buildPreset?.displayName || buildPreset?.name || '');
         const testPreset = project.testPreset;
         this.statusBar.setTestPresetName(testPreset?.displayName || testPreset?.name || '');
-        return presetSelected;
+        return presetSelected ? configurePreset?.name ?? '' : '';
     }
 
     viewConfigureSettings(): void {
@@ -2201,26 +2197,26 @@ export class ExtensionManager implements vscode.Disposable {
     /**
      * Show UI to allow the user to select an active build preset
      */
-    async selectBuildPreset(folder?: vscode.WorkspaceFolder): Promise<boolean> {
+    async selectBuildPreset(folder?: vscode.WorkspaceFolder): Promise<string> {
         if (util.isTestMode()) {
             log.trace(localize('selecting.build.preset.in.test.mode', 'Running CMakeTools in test mode. selectBuildPreset is disabled.'));
-            return false;
+            return '';
         }
 
         const project = this.getProjectFromFolder(folder);
         if (!project) {
-            return false;
+            return '';
         }
 
         if (!project.useCMakePresets) {
             log.info(localize('skip.set.build.preset', 'Using kits, skip selecting build preset'));
-            return false;
+            return '';
         }
 
         const presetSelected = await project.presetsController.selectBuildPreset();
         const buildPreset = project.buildPreset;
         this.statusBar.setBuildPresetName(buildPreset?.displayName || buildPreset?.name || '');
-        return presetSelected;
+        return presetSelected ? buildPreset?.name ?? '' : '';
     }
 
     viewBuildSettings(): void {
@@ -2230,26 +2226,26 @@ export class ExtensionManager implements vscode.Disposable {
     /**
      * Show UI to allow the user to select an active test preset
      */
-    async selectTestPreset(folder?: vscode.WorkspaceFolder): Promise<boolean> {
+    async selectTestPreset(folder?: vscode.WorkspaceFolder): Promise<string> {
         if (util.isTestMode()) {
             log.trace(localize('selecting.test.preset.in.test.mode', 'Running CMakeTools in test mode. selectTestPreset is disabled.'));
-            return false;
+            return '';
         }
 
         const project = this.getProjectFromFolder(folder);
         if (!project) {
-            return false;
+            return '';
         }
 
         if (!project.useCMakePresets) {
             log.info(localize('skip.set.test.preset', 'Using kits, skip selecting test preset'));
-            return false;
+            return '';
         }
 
         const presetSelected = await project.presetsController.selectTestPreset();
         const testPreset = project.testPreset;
         this.statusBar.setTestPresetName(testPreset?.displayName || testPreset?.name || '');
-        return presetSelected;
+        return presetSelected ? testPreset?.name ?? '' : '';
     }
 
     viewTestSettings(): void {
@@ -2259,51 +2255,51 @@ export class ExtensionManager implements vscode.Disposable {
     /**
      * Show UI to allow the user to select an active package preset
      */
-    async selectPackagePreset(folder?: vscode.WorkspaceFolder): Promise<boolean> {
+    async selectPackagePreset(folder?: vscode.WorkspaceFolder): Promise<string> {
         if (util.isTestMode()) {
             log.trace(localize('selecting.package.preset.in.test.mode', 'Running CMakeTools in test mode. selectPackagePreset is disabled.'));
-            return false;
+            return '';
         }
 
         const project = this.getProjectFromFolder(folder);
         if (!project) {
-            return false;
+            return '';
         }
 
         if (!project.useCMakePresets) {
             log.info(localize('skip.set.package.preset', 'Using kits, skip selecting package preset'));
-            return false;
+            return '';
         }
 
         const presetSelected = await project.presetsController.selectPackagePreset();
         const packagePreset = project.packagePreset;
         this.statusBar.setPackagePresetName(packagePreset?.displayName || packagePreset?.name || '');
-        return presetSelected;
+        return presetSelected ? packagePreset?.name ?? '' : '';
     }
 
     /**
      * Show UI to allow the user to select an active workflow preset
      */
-    async selectWorkflowPreset(folder?: vscode.WorkspaceFolder): Promise<boolean> {
+    async selectWorkflowPreset(folder?: vscode.WorkspaceFolder): Promise<string> {
         if (util.isTestMode()) {
             log.trace(localize('selecting.workflow.preset.in.test.mode', 'Running CMakeTools in test mode. selectWorkflowPreset is disabled.'));
-            return false;
+            return '';
         }
 
         const project = this.getProjectFromFolder(folder);
         if (!project) {
-            return false;
+            return '';
         }
 
         if (!project.useCMakePresets) {
             log.info(localize('skip.set.workflow.preset', 'Using kits, skip selecting workflow preset'));
-            return false;
+            return '';
         }
 
         const presetSelected = await project.presetsController.selectWorkflowPreset();
         const workflowPreset = project.workflowPreset;
         this.statusBar.setWorkflowPresetName(workflowPreset?.displayName || workflowPreset?.name || '');
-        return presetSelected;
+        return presetSelected ? workflowPreset?.name ?? '' : '';
     }
 
     public api: CMakeToolsApiImpl;