Expose presets info via API (#4532)

* Use shared API types for presets and expose preset getters

* Replaced locally defined preset interfaces with those from the public API.
* Moved internal-only fields into `*Private` interfaces to preserve encapsulation.
* Added getter methods in CMakeProjectWrapper to expose configure, build, test, and package presets, and the useCMakePresets flag.
* Improves maintainability by aligning internal structures with API definitions.

Fixes: #4510

* update with telemetry

* update api dependency

* update versions

* update changelog

* update changelog

* update version

---------

Co-authored-by: Garrett Campbell <[email protected]>
Co-authored-by: Garrett Campbell <[email protected]>

Author: OrkunTokdemir

CHANGELOG.md

@@ -11,6 +11,7 @@ Features:
 - Add a command to substitute CMake Cache variables in `launch.json` and `tasks.json`. [#4422](https://github.com/microsoft/vscode-cmake-tools/pull/4422)
 - Add support for presets v10. [#4459](https://github.com/microsoft/vscode-cmake-tools/issues/4459), [#4445](https://github.com/microsoft/vscode-cmake-tools/issues/4452)
 - Add pre-fill project name using current folder name [#4533](https://github.com/microsoft/vscode-cmake-tools/pull/4533) [@HO-COOH](https://github.com/HO-COOH)
+- Add API v5 which adds presets api. [#4510](https://github.com/microsoft/vscode-cmake-tools/issues/4510) [@OrkunTokdemir](https://github.com/OrkunTokdemir)
 
 Improvements:
 

package.json

@@ -3848,7 +3848,7 @@
     "tsconfig-paths": "^3.11.0",
     "tslint": "^6.1.3",
     "typescript": "^4.1.5",
-    "vscode-cmake-tools": "^1.3.0",
+    "vscode-cmake-tools": "^1.5.0",
     "vscode-nls-dev": "^3.3.2",
     "webpack": "^5.94.0",
     "webpack-cli": "^4.5.0"

src/api.ts

@@ -14,7 +14,7 @@ import { logEvent } from './telemetry';
 export class CMakeToolsApiImpl implements api.CMakeToolsApi {
     constructor(private readonly manager: ExtensionManager) {}
 
-    version: api.Version = api.Version.v4;
+    version: api.Version = api.Version.v5;
 
     showUIElement(element: api.UIElement): Promise<void> {
         logApiTelemetry('showUIElement');
@@ -74,6 +74,7 @@ class CMakeProjectWrapper implements api.Project {
     constructor(private readonly project: CMakeProject) {}
 
     get codeModel() {
+        logApiTelemetry('getCodeModel');
         return this.project.codeModelContent ?? undefined;
     }
 
@@ -85,6 +86,31 @@ class CMakeProjectWrapper implements api.Project {
         return this.project.onSelectedConfigurationChangedApiEvent;
     }
 
+    get configurePreset() {
+        logApiTelemetry('getConfigurePreset');
+        return this.project.configurePreset ?? undefined;
+    }
+
+    get buildPreset() {
+        logApiTelemetry('getBuildPreset');
+        return this.project.buildPreset ?? undefined;
+    }
+
+    get testPreset() {
+        logApiTelemetry('getTestPreset');
+        return this.project.testPreset ?? undefined;
+    }
+
+    get packagePreset() {
+        logApiTelemetry('getPackagePreset');
+        return this.project.packagePreset ?? undefined;
+    }
+
+    get useCMakePresets() {
+        logApiTelemetry('getUseCMakePresets');
+        return this.project.useCMakePresets;
+    }
+
     configure(): Promise<void> {
         logApiTelemetry('configure');
         return withErrorCheck('configure', async () => (this.project.configure()));

src/extension.ts

@@ -2450,7 +2450,7 @@ async function setup(context: vscode.ExtensionContext, progress?: ProgressHandle
 
     return { getApi: (version: api.Version) => {
         // Since our API is backwards compatible, we can make our version number match that which was requested.
-        if (version === api.Version.v1 || version === api.Version.v2 || version === api.Version.v3 || version === api.Version.v4) {
+        if (version === api.Version.v1 || version === api.Version.v2 || version === api.Version.v3 || version === api.Version.v4 || version === api.Version.v5) {
             ext.api.version = version;
         }
         return ext.api;

src/presets/preset.ts

@@ -3,6 +3,7 @@ import * as nls from 'vscode-nls';
 import * as path from 'path';
 import * as vscode from "vscode";
 import * as lodash from "lodash";
+import * as api from 'vscode-cmake-tools';
 
 import * as util from '@cmt/util';
 import * as logging from '@cmt/logging';
@@ -34,27 +35,16 @@ export interface PresetsFile {
 
 export type VendorType = { [key: string]: any };
 
-export interface Preset {
-    name: string;
-    displayName?: string;
-    description?: string;
-    hidden?: boolean;
-    inherits?: string | string[];
-    environment?: EnvironmentWithNull;
-    vendor?: VendorType;
-    condition?: Condition | boolean | null;
-    isUserPreset?: boolean;
-
+export interface PresetPrivate {
     __parentEnvironment?: EnvironmentWithNull; // Private field that contains the parent environment, which might be a modified VS Dev Env, or simply process.env.
     __expanded?: boolean; // Private field to indicate if we have already expanded this preset.
     __inheritedPresetCondition?: boolean; // Private field to indicate the fully evaluated inherited preset condition.
     __file?: PresetsFile; // Private field to indicate the file where this preset was defined.
 }
+export interface Preset extends api.Preset, PresetPrivate {}
 
-export interface ValueStrategy {
-    value?: string;
-    strategy?: 'set' | 'external';
-}
+export type ValueStrategy = api.ValueStrategy;
+export type CacheVarType = api.CacheVarType;
 
 export interface WarningOptions {
     dev?: boolean;
@@ -86,13 +76,6 @@ enum FormatMode {
     Json = "json-v1"
 }
 
-export interface TraceOptions {
-    mode?: string;
-    format?: string;
-    source?: string[];
-    redirect: string;
-}
-
 export interface Condition {
     type: 'const' | 'equals' | 'notEquals' | 'inList' | 'notInList' | 'matches' | 'notMatches' | 'anyOf' | 'allOf' | 'not';
     value?: boolean;
@@ -235,8 +218,6 @@ export function evaluatePresetCondition(preset: Preset, allPresets: Preset[], re
     return undefined;
 }
 
-export type CacheVarType = null | boolean | string | { type: string; value: boolean | string };
-
 export type OsName = "Windows" | "Linux" | "macOS";
 
 export type VendorVsSettings = {
@@ -247,45 +228,19 @@ export type VendorVsSettings = {
     [key: string]: any;
 };
 
-export interface ConfigurePreset extends Preset {
-    generator?: string;
-    architecture?: string | ValueStrategy;
-    toolset?: string | ValueStrategy;
-    binaryDir?: string;
-    cmakeExecutable?: string;
-    // Make the cache value to be possibly undefined for type checking
-    cacheVariables?: { [key: string]: CacheVarType | undefined };
-    warnings?: WarningOptions;
-    errors?: ErrorOptions;
-    debug?: DebugOptions;
-    trace?: TraceOptions;
-    vendor?: VendorVsSettings | VendorType;
-    toolchainFile?: string;
-    installDir?: string;
-    graphviz?: string;
-
+export interface ConfigurePreset extends PresetPrivate, api.ConfigurePreset {
     // Private fields
     __developerEnvironmentArchitecture?: string; // Private field to indicate which VS Dev Env architecture we're using, if VS Dev Env is used.
 }
 
-export interface InheritsConfigurePreset extends Preset {
-    configurePreset?: string;
-    inheritConfigureEnvironment?: boolean; // Defaults to true
-}
-
-export interface BuildPreset extends InheritsConfigurePreset {
-    jobs?: number;
-    targets?: string | string[];
-    configuration?: string;
-    cleanFirst?: boolean;
-    verbose?: boolean;
-    nativeToolOptions?: string[];
+export interface InheritsConfigurePreset extends api.InheritsConfigurePreset, PresetPrivate {}
 
-    // Private fields
+export interface BuildPresetPrivate {
     __binaryDir?: string; // Getting this from the config preset
     __generator?: string; // Getting this from the config preset
     __targets?: string | string[]; // This field is translated to build args, so we can overwrite the target arguments.
 }
+export interface BuildPreset extends api.BuildPreset, BuildPresetPrivate, PresetPrivate {}
 
 /**
  * Should NOT cache anything. Need to make a copy if any fields need to be changed.
@@ -296,86 +251,18 @@ export const defaultBuildPreset: BuildPreset = {
     description: localize('default.build.preset.description', 'An empty build preset that does not add any arguments')
 };
 
-export interface OutputOptions {
-    shortProgress?: boolean;
-    verbosity?: 'default' | 'verbose' | 'extra';
-    debug?: boolean;
-    outputOnFailure?: boolean;
-    quiet?: boolean;
-    outputLogFile?: string;
-    outputJUnitFile?: string;
-    labelSummary?: boolean;
-    subprojectSummary?: boolean;
-    maxPassedTestOutputSize?: number;
-    maxFailedTestOutputSize?: number;
-    testOutputTruncation?: 'tail' | 'heads' | 'middle';
-    maxTestNameWidth?: number;
-}
-
-export interface IncludeFilter {
-    name?: string;
-    label?: string;
-    useUnion?: boolean;
-    index?: string | { start?: number; end?: number; stride?: number; specificTests?: number[] };
-}
-
-export interface ExcludeFilter {
-    name?: string;
-    label?: string;
-    fixtures?: { any?: string; setup?: string; cleanup?: string };
-}
-
-export interface TestFilter {
-    include?: IncludeFilter;
-    exclude?: ExcludeFilter;
-}
-
-export interface ExecutionOptions {
-    stopOnFailure?: boolean;
-    enableFailover?: boolean;
-    jobs?: number;
-    resourceSpecFile?: string;
-    testLoad?: number;
-    showOnly?: 'human' | 'json-v1';
-    repeat?: { mode: 'until-fail' | 'until-pass' | 'after-timeout'; count: number };
-    interactiveDebugging?: boolean;
-    scheduleRandom?: boolean;
-    timeout?: number;
-    noTestsAction?: 'default' | 'error' | 'ignore';
-}
-
-export interface TestPreset extends InheritsConfigurePreset {
-    configuration?: string;
-    overwriteConfigurationFile?: string[];
-    output?: OutputOptions;
-    filter?: TestFilter;
-    execution?: ExecutionOptions;
-
-    // Private fields
+export interface TestPresetPrivate {
     __binaryDir?: string; // Getting this from the config preset
     __generator?: string; // Getting this from the config preset
 }
 
-export interface PackageOutputOptions {
-    debug?: boolean;
-    verbose?: boolean;
-}
-
-export interface PackagePreset extends InheritsConfigurePreset {
-    configurations?: string[];
-    generators?: string[];
-    variables?: { [key: string]: string | null | undefined };
-    configFile?: string;
-    output?: PackageOutputOptions;
-    packageName?: string;
-    packageVersion?: string;
-    packageDirectory?: string;
-    vendorName?: string;
+export interface TestPreset extends api.TestPreset, TestPresetPrivate, PresetPrivate {}
 
-    // Private fields
+export interface PackagePresetPrivate {
     __binaryDir?: string; // Getting this from the config preset
     __generator?: string; // Getting this from the config preset
 }
+export interface PackagePreset extends api.PackagePreset, PackagePresetPrivate, PresetPrivate {}
 
 export interface WorkflowStepsOptions {
     type: string;

yarn.lock

@@ -7570,10 +7570,10 @@ vinyl@^2.0.0, vinyl@^2.1.0:
     remove-trailing-separator "^1.0.1"
     replace-ext "^1.0.0"
 
-vscode-cmake-tools@^1.3.0:
-  version "1.3.0"
-  resolved "https://pkgs.dev.azure.com/azure-public/VisualCpp/_packaging/cpp_PublicPackages/npm/registry/vscode-cmake-tools/-/vscode-cmake-tools-1.3.0.tgz#f84707d77468cfcb34c386140eb62f966cccccc8"
-  integrity sha1-+EcH13Roz8s0w4YUDrYvlmzMzMg=
+vscode-cmake-tools@^1.5.0:
+  version "1.5.0"
+  resolved "https://pkgs.dev.azure.com/azure-public/VisualCpp/_packaging/cpp_PublicPackages/npm/registry/vscode-cmake-tools/-/vscode-cmake-tools-1.5.0.tgz#208d15ab4364861f7bad17282bb4f1d47539248a"
+  integrity sha1-II0Vq0Nkhh97rRcoK7Tx1HU5JIo=
 
 vscode-cpptools@^7.1.1:
   version "7.1.1"