Update Preferred Generator selection logic

CHANGELOG.md

@@ -21,6 +21,7 @@ Bug Fixes:
 - Fix issue where `preferredGenerator.platform` and `preferredGenerator.toolset` wasn't being compared between the old and new kit to trigger a clean configure on a kit selection change. [#2699](https://github.com/microsoft/vscode-cmake-tools/issues/2699)
 - Still allow for users to add `--warn-unused-cli`. Now instead of overriding, it will remove our default `--no-warn-unused-cli`. [#1090](https://github.com/microsoft/vscode-cmake-tools/issues/1090)
 - Ensure `useCMakePresets` context is set after making a CMakePreset.json with `Quick Start`. [#3734](https://github.com/microsoft/vscode-cmake-tools/issues/3734)
+- Fix issue where `cmake.preferredGenerators` wasn't falling back to the next entry when the first entry didn't exist [#2709](https://github.com/microsoft/vscode-cmake-tools/issues/2709)
 
 ## 1.18.42
 

src/cmakeProject.ts

@@ -823,18 +823,20 @@ export class CMakeProject {
     }
 
     private getPreferredGenerators(): CMakeGenerator[] {
-        // User can override generator with a setting
+        const userPreferred: CMakeGenerator[] = this.workspaceContext.config.preferredGenerators
+            .map(g => ({ name: g }));
+
+        // The generator setting is placed at the front of user preferred generators
         const userGenerator = this.workspaceContext.config.generator;
         if (userGenerator) {
             log.debug(localize('using.user.generator', 'Using generator from user configuration: {0}', userGenerator));
-            return [{
+            userPreferred.unshift({
                 name: userGenerator,
                 platform: this.workspaceContext.config.platform || undefined,
                 toolset: this.workspaceContext.config.toolset || undefined
-            }];
+            });
         }
 
-        const userPreferred = this.workspaceContext.config.preferredGenerators.map(g => ({ name: g }));
         return userPreferred;
     }
 

src/drivers/cmakeDriver.ts

@@ -721,8 +721,9 @@ export abstract class CMakeDriver implements vscode.Disposable {
         log.debug(localize('cmakedriver.kit.set.to', 'CMakeDriver Kit set to {0}', kit.name));
         this._kitEnvironmentVariables = await effectiveKitEnvironment(kit, this.expansionOptions);
 
+        // Place a kit preferred generator at the front of the list
         if (kit.preferredGenerator) {
-            preferredGenerators.push(kit.preferredGenerator);
+            preferredGenerators.unshift(kit.preferredGenerator);
         }
 
         // If no preferred generator is defined by the current kit or the user settings,
@@ -732,17 +733,17 @@ export abstract class CMakeDriver implements vscode.Disposable {
             preferredGenerators.push({ name: "Unix Makefiles" });
         }
 
-        // Use the "best generator" selection logic only if the user did not define already
-        // in settings (via "cmake.generator") a particular generator to be used.
+        // If a generator is set in the "cmake.generator" setting, push it to the front
+        // of the "best generator" logic
         if (this.config.generator) {
-            this._generator = {
+            preferredGenerators.unshift({
                 name: this.config.generator,
                 platform: this.config.platform || undefined,
                 toolset: this.config.toolset || undefined
-            };
-        } else {
-            this._generator = await this.findBestGenerator(preferredGenerators);
+            });
         }
+
+        this._generator = await this.findBestGenerator(preferredGenerators);
     }
 
     protected abstract doSetConfigurePreset(needsClean: boolean, cb: () => Promise<void>): Promise<void>;
@@ -1003,10 +1004,8 @@ export abstract class CMakeDriver implements vscode.Disposable {
                 if (gen.name.toLowerCase().startsWith('xcode') && platform === 'darwin') {
                     return gen;
                 }
-                // If it is not a common generator that we can find, but it is a known cmake generator (cmakeGenerators), return it.
-                if (this.cmakeGenerators.indexOf(gen.name) >= 0 && !this.isCommonGenerator(gen.name)) {
-                    return gen;
-                }
+
+                // If the generator isn't found, move on to the next one
                 continue;
             } else {
                 return gen;