Add setting "postConfigureTask" (#4566)

* Squashed commit of the following:

Add post configure task

* add missing line in config.ts

* Update documentation

* Add changelog entry and localization string for postConfigureTask

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

---------

Co-authored-by: Sneha Ramachandran <[email protected]>
Co-authored-by: Copilot <[email protected]>
Co-authored-by: snehara99 <[email protected]>

Author: 3 people

CHANGELOG.md

@@ -7,6 +7,7 @@ Features:
 - Add command to clear build diagnostics from the Problems pane. [#4691](https://github.com/microsoft/vscode-cmake-tools/pull/4691)
 - Add individual CTest test nodes to the Project Outline with inline run/debug buttons, and enable debugging tests from both the Outline and Test Explorer without requiring a launch.json. [#4721](https://github.com/microsoft/vscode-cmake-tools/pull/4721)
 - Add "Delete Cache, Reconfigure and Build" command that chains cache deletion, reconfiguration, and build into a single action. [#4723](https://github.com/microsoft/vscode-cmake-tools/pull/4723)
+- Add `cmake.postConfigureTask` setting to execute a named VS Code task after every successful CMake configure. [#4566](https://github.com/microsoft/vscode-cmake-tools/pull/4566) [@Francois-Le](https://github.com/Francois-Le)
 - Add "Set Build and Launch/Debug Target" command that sets both the build target and launch target simultaneously. [#4732](https://github.com/microsoft/vscode-cmake-tools/pull/4732)
 
 Improvements:

docs/cmake-settings.md

@@ -30,6 +30,7 @@ Options that support substitution, in the table below, allow variable references
 | `cmake.configureOnOpen` | Automatically configure CMake project directories when they are opened. | `true` | no |
 | `cmake.configureSettings` | An object containing `key:value` pairs, which will be passed to CMake when configuring. The same as passing `-DVAR_NAME=ON` via `cmake.configureArgs`. NOTE: Semicolons (`;`) in string values are automatically escaped to prevent CMake from interpreting them as list separators. If you want to pass a CMake list, use array notation instead, e.g. `"MY_LIST": [ "a", "b" ]`. | `{}` (no values) | yes |
 | `cmake.copyCompileCommands`| If not `null`, copies the `compile_commands.json` file generated by CMake to the path specified by this setting whenever CMake successfully configures. |  `null` (do not copy the file) | yes |
+| `cmake.postConfigureTask`| If not `null`, the task with this name is executed whenever CMake successfully configures. |  `null` (do not run any task) | yes |
 | `cmake.coverageInfoFiles` | LCOV coverage info files to be processed after running tests with coverage using the test explorer. | `[]` | yes |
 | `cmake.cpackArgs` | An array of additional arguments to pass to cpack. | `[]` | yes |
 | `cmake.cpackEnvironment` | An object containing `key:value` pairs of environment variables, which will be available when running cpack. | `{}` | yes |

package.json

@@ -2912,6 +2912,12 @@
           "description": "%cmake-tools.configuration.cmake.copyCompileCommands.description%",
           "scope": "resource"
         },
+        "cmake.postConfigureTask": {
+          "type": "string",
+          "default": null,
+          "description": "%cmake-tools.configuration.cmake.postConfigureTask.description%",
+          "scope": "resource"
+        },
         "cmake.configureOnOpen": {
           "type": "boolean",
           "default": true,

package.nls.json

@@ -226,6 +226,7 @@
     "cmake-tools.configuration.cmake.emscriptenSearchDirs.description": "Directories where Emscripten may be installed.",
     "cmake-tools.configuration.cmake.mergedCompileCommands.description": "Recursively collect and merge all compile_commands.json found in the cmake.buildDirectory.",
     "cmake-tools.configuration.cmake.copyCompileCommands.description": "Copy compile_commands.json to this location after a successful configure.",
+    "cmake-tools.configuration.cmake.postConfigureTask.description": "If set, this named task will be executed after a successful CMake configure.",
     "cmake-tools.configuration.cmake.configureOnOpen.description": "Automatically configure CMake project directories when they are opened.",
     "cmake-tools.configuration.cmake.configureOnEdit.description": "Automatically configure CMake project directories when cmake.sourceDirectory or CMakeLists.txt content are saved.",
     "cmake-tools.configuration.cmake.deleteBuildDirOnCleanConfigure.description": "Delete the entire build directory when a clean configure is invoked.",

src/cmakeProject.ts

@@ -1615,6 +1615,36 @@ export class CMakeProject {
                 return;
             }
         }
+
+    }
+
+    /**
+     * Execute the postConfigureTask if configured
+     */
+    private async executePostConfigureTask(): Promise<void> {
+        const postConfigureTask = this.workspaceContext.config.postConfigureTask;
+        if (postConfigureTask) {
+            try {
+                log.debug(localize('executing.post.configure.task', 'Executing post configure task: {0}', postConfigureTask));
+
+                // Fetch all available tasks
+                const tasks = await vscode.tasks.fetchTasks();
+
+                // Find the task by label
+                const task = tasks.find(t => t.name === postConfigureTask);
+
+                if (task) {
+                    await vscode.tasks.executeTask(task);
+                } else {
+                    const errorMsg = localize('task.not.found', 'Task "{0}" not found. Available tasks: {1}', postConfigureTask, tasks.map(t => t.name).join(', '));
+                    void vscode.window.showErrorMessage(errorMsg);
+                    log.error(errorMsg);
+                }
+            } catch (error: any) {
+                void vscode.window.showErrorMessage(localize('failed.to.execute.post.configure.task', 'Failed to execute post configure task: {0}', error.toString()));
+                log.error(localize('post.configure.task.error', 'Error executing post configure task'), error);
+            }
+        }
     }
 
     /**
@@ -1638,6 +1668,7 @@ export class CMakeProject {
             const result: ConfigureResult = await drv.configure(trigger, []);
             if (result.exitCode === 0) {
                 await this.refreshCompileDatabase(drv.expansionOptions);
+                await this.executePostConfigureTask();
             } else {
                 log.showChannel(true);
             }
@@ -1739,6 +1770,7 @@ export class CMakeProject {
                                 if (result.exitCode === 0) {
                                     await enableFullFeatureSet(true);
                                     await this.refreshCompileDatabase(drv.expansionOptions);
+                                    await this.executePostConfigureTask();
                                 } else if (result.exitCode !== 0 && (await this.getCMakeExecutable()).isDebuggerSupported && cmakeConfiguration.get(showDebuggerConfigurationString) && !forciblyCanceled && !cancelInformation.canceled && result.resultType === ConfigureResultType.NormalOperation) {
                                     log.showChannel(true);
                                     const yesButtonTitle: string = localize(

src/config.ts

@@ -204,6 +204,7 @@ export interface ExtensionConfigurationSettings {
     emscriptenSearchDirs: string[];
     mergedCompileCommands: string | null;
     copyCompileCommands: string | null;
+    postConfigureTask: string | null;
     loadCompileCommands: boolean;
     configureOnOpen: boolean;
     configureOnEdit: boolean;
@@ -549,6 +550,9 @@ export class ConfigurationReader implements vscode.Disposable {
     get copyCompileCommands(): string | null {
         return this.configData.copyCompileCommands;
     }
+    get postConfigureTask(): string | null {
+        return this.configData.postConfigureTask;
+    }
     get loadCompileCommands(): boolean {
         return this.configData.loadCompileCommands;
     }
@@ -656,6 +660,7 @@ export class ConfigurationReader implements vscode.Disposable {
         emscriptenSearchDirs: new vscode.EventEmitter<string[]>(),
         mergedCompileCommands: new vscode.EventEmitter<string | null>(),
         copyCompileCommands: new vscode.EventEmitter<string | null>(),
+        postConfigureTask: new vscode.EventEmitter<string | null>(),
         loadCompileCommands: new vscode.EventEmitter<boolean>(),
         configureOnOpen: new vscode.EventEmitter<boolean>(),
         configureOnEdit: new vscode.EventEmitter<boolean>(),

test/unit-tests/config.test.ts

@@ -85,7 +85,8 @@ function createConfig(conf: Partial<ExtensionConfigurationSettings>): Configurat
         preRunCoverageTarget: null,
         postRunCoverageTarget: null,
         coverageInfoFiles: [],
-        useFolderPropertyInBuildTargetDropdown: true
+        useFolderPropertyInBuildTargetDropdown: true,
+        postConfigureTask: null
     });
     ret.updatePartial(conf);
     return ret;