feat: add CMake: Install Component command (#4281)

Add a new 'CMake: Install Component' command that uses 'cmake --install
<dir> --component <name>' to install specific CMake install components.

- Add parseInstallComponentsFromContent() to parse cmake_install.cmake
- Add getInstallComponents() method on CMakeProject
- Add showComponentSelector() with QuickPick and InputBox fallback
- Add installComponent() method on CMakeProject and ExtensionManager
- Register cmake.installComponent command in package.json
- Add unit tests for component parsing
- Require CMake >= 3.15 with version guard

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

Author: 2 people

CHANGELOG.md

@@ -4,6 +4,7 @@
 
 Features:
 - Add `cmake.shell` setting to route CMake/CTest/CPack subprocess invocations through a custom shell (e.g., Git Bash, MSYS2), enabling embedded toolchains that require POSIX path translation on Windows. [#1750](https://github.com/microsoft/vscode-cmake-tools/issues/1750)
+- Add "CMake: Install Component" command for installing specific CMake install components. [#4281](https://github.com/microsoft/vscode-cmake-tools/issues/4281)
 - triple: Add riscv32be riscv64be support. [#4648](https://github.com/microsoft/vscode-cmake-tools/pull/4648) [@lygstate](https://github.com/lygstate)
 - Add command to clear build diagnostics from the Problems pane. [#4691](https://github.com/microsoft/vscode-cmake-tools/pull/4691)
 - Clear build diagnostics from the Problems pane when a new build starts and populate them incrementally during the build. [#4608](https://github.com/microsoft/vscode-cmake-tools/issues/4608)

package.json

@@ -490,6 +490,12 @@
         "when": "cmake:enableFullFeatureSet",
         "category": "CMake"
       },
+      {
+        "command": "cmake.installComponent",
+        "title": "%cmake-tools.command.cmake.installComponent.title%",
+        "when": "cmake:enableFullFeatureSet",
+        "category": "CMake"
+      },
       {
         "command": "cmake.buildWithTarget",
         "title": "%cmake-tools.command.cmake.buildWithTarget.title%",

package.nls.json

@@ -40,6 +40,7 @@
     "cmake-tools.command.cmake.outline.compileFile.title": "Compile File",
     "cmake-tools.command.cmake.install.title": "Install",
     "cmake-tools.command.cmake.installAll.title": "Install All Projects",
+    "cmake-tools.command.cmake.installComponent.title": "Install Component",
     "cmake-tools.command.cmake.buildWithTarget.title": "Build Target",
     "cmake-tools.command.cmake.setDefaultTarget.title": "Set Build Target",
     "cmake-tools.command.cmake.cleanConfigure.title": "Delete Cache and Reconfigure",

src/cmakeProject.ts

@@ -54,6 +54,7 @@ import { DebugTrackerFactory, DebuggerInformation, getDebuggerPipeName } from '@
 import { NamedTarget, RichTarget, FolderTarget } from '@cmt/drivers/cmakeDriver';
 
 import { CommandResult, ConfigurationType } from 'vscode-cmake-tools';
+import { parseInstallComponentsFromContent } from '@cmt/installUtils';
 
 nls.config({ messageFormat: nls.MessageFormat.bundle, bundleFormat: nls.BundleFormat.standalone })();
 const localize: nls.LocalizeFunc = nls.loadMessageBundle();
@@ -2639,6 +2640,121 @@ export class CMakeProject {
         return this.build(['install'], false, false, cancellationToken);
     }
 
+    /**
+     * Parse cmake_install.cmake in the build directory to discover install component names.
+     */
+    async getInstallComponents(): Promise<string[]> {
+        const binaryDir = await this.binaryDir;
+        if (!binaryDir) {
+            return [];
+        }
+        const cmakeInstallFile = path.join(binaryDir, 'cmake_install.cmake');
+        if (!await fs.exists(cmakeInstallFile)) {
+            return [];
+        }
+        try {
+            const content = await fs.readFile(cmakeInstallFile);
+            return parseInstallComponentsFromContent(content);
+        } catch {
+            return [];
+        }
+    }
+
+    /**
+     * Show a picker for selecting an install component. Falls back to input box when no components found.
+     */
+    async showComponentSelector(): Promise<string | null> {
+        const components = await this.getInstallComponents();
+        if (components.length > 0) {
+            const sel = await vscode.window.showQuickPick(
+                components.map(c => ({ label: c, description: localize('install.component.description', 'Install component') })),
+                { placeHolder: localize('select.install.component', 'Select an install component') }
+            );
+            return sel ? sel.label : null;
+        }
+        return await vscode.window.showInputBox({ prompt: localize('enter.component.name', 'Enter a component name') }) || null;
+    }
+
+    /**
+     * Implementation of `cmake.installComponent`
+     */
+    async installComponent(component?: string): Promise<CommandResult> {
+        if (!component) {
+            const selected = await this.showComponentSelector();
+            if (!selected) {
+                return { exitCode: -1 };
+            }
+            component = selected;
+        }
+
+        const cmake = await this.getCMakeExecutable();
+        if (!cmake.isPresent) {
+            void vscode.window.showErrorMessage(localize('bad.executable', 'Bad CMake executable: {0}. Check to make sure it is installed or the value of the {1} setting contains the correct path', `"${cmake.path}"`, '"cmake.cmakePath"'));
+            return { exitCode: -1 };
+        }
+
+        const minInstallVersion = util.parseVersion('3.15.0');
+        if (!cmake.version || !util.versionGreaterOrEquals(cmake.version, minInstallVersion)) {
+            void vscode.window.showErrorMessage(localize('cmake.install.component.version.error', 'CMake version 3.15 or later is required for component-based install. Current version: {0}', cmake.version ? util.versionToString(cmake.version) : 'unknown'));
+            return { exitCode: -1 };
+        }
+
+        const drv = await this.getCMakeDriverInstance();
+        if (!drv) {
+            void vscode.window.showErrorMessage(localize('set.up.before.install.component', 'Set up your CMake project before installing a component.'));
+            return { exitCode: -1 };
+        }
+
+        const configResult = await this.ensureConfigured();
+        if (configResult === null || configResult.exitCode !== 0) {
+            return { exitCode: configResult?.exitCode ?? -1 };
+        }
+
+        // Re-fetch driver after configure
+        const driver = await this.getCMakeDriverInstance();
+        if (!driver) {
+            return { exitCode: -1 };
+        }
+
+        const binaryDir = driver.binaryDir;
+        const args: string[] = ['--install', binaryDir, '--component', component];
+
+        const buildType = await this.currentBuildType();
+        if (buildType) {
+            args.push('--config', buildType);
+        }
+
+        const installPrefix = this.workspaceContext.config.installPrefix;
+        if (installPrefix) {
+            const opts = driver.expansionOptions;
+            const expandedPrefix = await expandString(installPrefix, opts);
+            args.push('--prefix', expandedPrefix);
+        }
+
+        log.showChannel();
+        buildLogger.info(localize('starting.install.component', 'Installing component: {0}', component));
+
+        return vscode.window.withProgress(
+            {
+                location: vscode.ProgressLocation.Window,
+                title: localize('installing.component', 'Installing component: {0}', component),
+                cancellable: true
+            },
+            async (_progress, cancel) => {
+                cancel.onCancellationRequested(() => rollbar.invokeAsync(localize('stop.on.cancellation', 'Stop on cancellation'), () => this.stop()));
+                const child = driver.executeCommand(cmake.path, args, undefined, {});
+                const result = await child.result;
+                if (result.retc !== 0) {
+                    buildLogger.error(localize('install.component.failed', 'Install component failed with exit code {0}', result.retc));
+                    log.showChannel(true);
+                } else {
+                    buildLogger.info(localize('install.component.finished', 'Install component finished successfully'));
+                }
+                return { exitCode: result.retc ?? -1 };
+            }
+        );
+    }
+
     /**
      * Implementation of `cmake.stop`
      */
@@ -3763,3 +3879,5 @@ export class CMakeProject {
 }
 
 export default CMakeProject;
+
+export { parseInstallComponentsFromContent } from '@cmt/installUtils';

src/extension.ts

@@ -1541,6 +1541,19 @@ export class ExtensionManager implements vscode.Disposable {
         return this.runCMakeCommandForAll(cmakeProject => cmakeProject.install(), undefined, true);
     }
 
+    async installComponent(component?: string) {
+        telemetry.logEvent("install", { command: "installComponent"});
+        this.cleanOutputChannel();
+        let activeProject: CMakeProject | undefined = this.getActiveProject();
+        if (!activeProject) {
+            activeProject = await this.pickCMakeProject();
+            if (!activeProject) {
+                return; // Error or nothing is opened
+            }
+        }
+        return activeProject.installComponent(component);
+    }
+
     editCache(folder: vscode.WorkspaceFolder) {
         telemetry.logEvent("editCMakeCache", { command: "editCMakeCache" });
         return this.runCMakeCommand(cmakeProject => cmakeProject.editCache(), folder);
@@ -2425,6 +2438,7 @@ async function setup(context: vscode.ExtensionContext, progress?: ProgressHandle
         'setVariantAll',
         'install',
         'installAll',
+        'installComponent',
         'editCache',
         'clean',
         'cleanAll',

src/installUtils.ts

@@ -0,0 +1,18 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+/**
+ * Parse install component names from cmake_install.cmake file content.
+ * Extracts component names from `if(CMAKE_INSTALL_COMPONENT STREQUAL "<name>")` blocks.
+ */
+export function parseInstallComponentsFromContent(content: string): string[] {
+    const regex = /if\(CMAKE_INSTALL_COMPONENT\s+STREQUAL\s+"([^"]+)"/g;
+    const components = new Set<string>();
+    let match: RegExpExecArray | null;
+    while ((match = regex.exec(content)) !== null) {
+        components.add(match[1]);
+    }
+    return Array.from(components).sort();
+}

test/unit-tests/backend/installComponents.test.ts

@@ -0,0 +1,123 @@
+import { expect } from 'chai';
+import { parseInstallComponentsFromContent } from '@cmt/installUtils';
+
+suite('parseInstallComponentsFromContent', () => {
+    test('parses single component', () => {
+        const content = `
+if(CMAKE_INSTALL_COMPONENT STREQUAL "Runtime")
+  file(INSTALL DESTINATION "\${CMAKE_INSTALL_PREFIX}/bin" TYPE EXECUTABLE FILES "/path/to/app")
+endif()
+`;
+        const components = parseInstallComponentsFromContent(content);
+        expect(components).to.deep.equal(['Runtime']);
+    });
+
+    test('parses multiple components', () => {
+        const content = `
+if(CMAKE_INSTALL_COMPONENT STREQUAL "Runtime")
+  file(INSTALL DESTINATION "\${CMAKE_INSTALL_PREFIX}/bin" TYPE EXECUTABLE FILES "/path/to/app")
+endif()
+
+if(CMAKE_INSTALL_COMPONENT STREQUAL "Development")
+  file(INSTALL DESTINATION "\${CMAKE_INSTALL_PREFIX}/include" TYPE FILE FILES "/path/to/header.h")
+endif()
+
+if(CMAKE_INSTALL_COMPONENT STREQUAL "Documentation")
+  file(INSTALL DESTINATION "\${CMAKE_INSTALL_PREFIX}/share/doc" TYPE FILE FILES "/path/to/readme.md")
+endif()
+`;
+        const components = parseInstallComponentsFromContent(content);
+        expect(components).to.deep.equal(['Development', 'Documentation', 'Runtime']);
+    });
+
+    test('deduplicates repeated components', () => {
+        const content = `
+if(CMAKE_INSTALL_COMPONENT STREQUAL "Runtime")
+  file(INSTALL DESTINATION "\${CMAKE_INSTALL_PREFIX}/bin" TYPE EXECUTABLE FILES "/path/to/app1")
+endif()
+
+if(CMAKE_INSTALL_COMPONENT STREQUAL "Runtime")
+  file(INSTALL DESTINATION "\${CMAKE_INSTALL_PREFIX}/bin" TYPE EXECUTABLE FILES "/path/to/app2")
+endif()
+`;
+        const components = parseInstallComponentsFromContent(content);
+        expect(components).to.deep.equal(['Runtime']);
+    });
+
+    test('returns empty array when no components found', () => {
+        const content = `
+# No install components in this file
+cmake_minimum_required(VERSION 3.15)
+`;
+        const components = parseInstallComponentsFromContent(content);
+        expect(components).to.deep.equal([]);
+    });
+
+    test('returns empty array for empty content', () => {
+        const components = parseInstallComponentsFromContent('');
+        expect(components).to.deep.equal([]);
+    });
+
+    test('returns sorted components', () => {
+        const content = `
+if(CMAKE_INSTALL_COMPONENT STREQUAL "Zebra")
+  file(INSTALL DESTINATION "\${CMAKE_INSTALL_PREFIX}/bin" TYPE FILE FILES "/path/to/z")
+endif()
+
+if(CMAKE_INSTALL_COMPONENT STREQUAL "Alpha")
+  file(INSTALL DESTINATION "\${CMAKE_INSTALL_PREFIX}/bin" TYPE FILE FILES "/path/to/a")
+endif()
+
+if(CMAKE_INSTALL_COMPONENT STREQUAL "Middle")
+  file(INSTALL DESTINATION "\${CMAKE_INSTALL_PREFIX}/bin" TYPE FILE FILES "/path/to/m")
+endif()
+`;
+        const components = parseInstallComponentsFromContent(content);
+        expect(components).to.deep.equal(['Alpha', 'Middle', 'Zebra']);
+    });
+
+    test('handles typical cmake_install.cmake content', () => {
+        const content = `# Install script for directory: /home/user/project
+
+# Set the install prefix
+if(NOT DEFINED CMAKE_INSTALL_PREFIX)
+  set(CMAKE_INSTALL_PREFIX "/usr/local")
+endif()
+string(REGEX REPLACE "/\$" "" CMAKE_INSTALL_PREFIX "\${CMAKE_INSTALL_PREFIX}")
+
+# Set the install configuration name.
+if(NOT DEFINED CMAKE_INSTALL_CONFIG_NAME)
+  if(BUILD_TYPE)
+    string(REGEX REPLACE "^[^A-Za-z0-9_]+" "" CMAKE_INSTALL_CONFIG_NAME "\${BUILD_TYPE}")
+  else()
+    set(CMAKE_INSTALL_CONFIG_NAME "")
+  endif()
+  message(STATUS "Install configuration: \\"\${CMAKE_INSTALL_CONFIG_NAME}\\"")
+endif()
+
+if(CMAKE_INSTALL_COMPONENT STREQUAL "Runtime" OR NOT CMAKE_INSTALL_COMPONENT)
+  file(INSTALL DESTINATION "\${CMAKE_INSTALL_PREFIX}/bin" TYPE EXECUTABLE FILES "/path/to/app")
+endif()
+
+if(CMAKE_INSTALL_COMPONENT STREQUAL "Development" OR NOT CMAKE_INSTALL_COMPONENT)
+  file(INSTALL DESTINATION "\${CMAKE_INSTALL_PREFIX}/lib" TYPE STATIC_LIBRARY FILES "/path/to/lib.a")
+endif()
+
+if(CMAKE_INSTALL_COMPONENT STREQUAL "Headers" OR NOT CMAKE_INSTALL_COMPONENT)
+  file(INSTALL DESTINATION "\${CMAKE_INSTALL_PREFIX}/include" TYPE FILE FILES "/path/to/header.h")
+endif()
+`;
+        const components = parseInstallComponentsFromContent(content);
+        expect(components).to.deep.equal(['Development', 'Headers', 'Runtime']);
+    });
+
+    test('handles components with special characters in names', () => {
+        const content = `
+if(CMAKE_INSTALL_COMPONENT STREQUAL "my-component_v2")
+  file(INSTALL DESTINATION "\${CMAKE_INSTALL_PREFIX}/bin" TYPE FILE FILES "/path/to/file")
+endif()
+`;
+        const components = parseInstallComponentsFromContent(content);
+        expect(components).to.deep.equal(['my-component_v2']);
+    });
+});