Add cmake.exclude setting to allow for multi-root scenarios to ignore certain folders (#4440)

* Add the cmake.ignoredFolders setting.

Added the ignoredFolders setting in the code such that it compiles.
TODO to implement the usage of this setting in the extension.

* update changelog, docs, and description

* modify folderToProjectsMap to hold a vscode.WorkspaceFolder rather than string as key

* rename loadAllProjects to loadAllFolders and add comment explaining what I think we should refactor

* fix incorrect rebase

* saving progress

* make ignore logic more specific, handle removal from test explorer when sourceDirectory is changed

* remove duplicate docs/cmake-settings entry

* slight refactors to make more performant

* fix workspace ignoredFolder handler to fix multiple invocation issue

* use a more vscode-y name with cmake.exclude rather than cmake.ignoredFolders

* fix string

* update to ensure that the activeFolder updates accordingly

* add telemetry

* remove unused import

Author: gcampbell-msft

CHANGELOG.md

@@ -7,6 +7,7 @@ Features:
 - Add an option to specify the launch target for debugging CTest tests. [#4273](https://github.com/microsoft/vscode-cmake-tools/pull/4273)
 - Add a setting to enable/disable our built-in language services. [#4290](https://github.com/microsoft/vscode-cmake-tools/issues/4290)
 - Add an option to group the default build target dropdown using CMake groups [#3953](https://github.com/microsoft/vscode-cmake-tools/pull/3953) [@itzandroidtab](https://github.com/itzandroidtab)
+- Add `cmake.exclude` setting that allows users to set folders that they want the CMake Tools extension to ignore. [#4112](https://github.com/microsoft/vscode-cmake-tools/issues/4112)
 
 Improvements:
 

docs/cmake-settings.md

@@ -52,6 +52,7 @@ Options that support substitution, in the table below, allow variable references
 | `cmake.enableLanguageServices` | If `true`, enable CMake language services. | `true` | no |
 | `cmake.enableTraceLogging` | If `true`, enable trace logging. | `false` | no |
 | `cmake.environment` | An object containing `key:value` pairs of environment variables, which will be available when configuring, building, or testing with CTest. | `{}` (no environment variables) | yes |
+| `cmake.exclude` | CMake Tools will ignore the folders defined in this setting. | `[]` | no |
 | `cmake.exportCompileCommandsFile` | If `true`, generate the compile_commands.json file. | `true` | no |
 | `cmake.generator` | Set to a string to override CMake Tools preferred generator logic. If set, CMake will unconditionally use it as the `-G` CMake generator command line argument. | `null` | no |
 | `cmake.ignoreCMakeListsMissing` | If `true`, do not show error when opening a project without CMakeLists.txt. | `false` | no |

package.json

@@ -2044,6 +2044,15 @@
           "description": "%cmake-tools.configuration.cmake.defaultActiveFolder.description%",
           "scope": "window"
         },
+        "cmake.exclude": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "default": [],
+          "description": "%cmake-tools.configuration.cmake.exclude.description%",
+          "scope": "window"
+        },
         "cmake.cmakePath": {
           "type": "string",
           "default": "cmake",

package.nls.json

@@ -200,6 +200,7 @@
     "cmake-tools.configuration.cmake.enableTraceLogging.description": "Enable trace logging to file and console (very noisy).",
     "cmake-tools.configuration.cmake.autoSelectActiveFolder.description": "Select active folder automatically.",
     "cmake-tools.configuration.cmake.defaultActiveFolder.description": "Set the default active folder (only works when cmake.autoSelectActiveFolder is disable).",
+    "cmake-tools.configuration.cmake.exclude.description": "The extension will ignore the folders listed in this setting. The folders should be listed as absolute paths.",
     "cmake-tools.configuration.cmake.touchbar.advanced.description": "Configures advanced settings for how the extension displays buttons on a MacBook Touch Bar.",
     "cmake-tools.configuration.cmake.touchbar.visibility.description": "Configures how the extension displays the buttons on a MacBook Touch Bar.",
     "cmake-tools.configuration.cmake.touchbar.visibility.default.description": "Show Touch Bar buttons on supported systems.",

src/config.ts

@@ -155,6 +155,7 @@ export interface OptionConfig {
 export interface ExtensionConfigurationSettings {
     autoSelectActiveFolder: boolean;
     defaultActiveFolder: string | null;
+    exclude: string[];
     cmakePath: string;
     buildDirectory: string;
     installPrefix: string | null;
@@ -322,6 +323,10 @@ export class ConfigurationReader implements vscode.Disposable {
     get defaultActiveFolder(): string | null {
         return this.configData.defaultActiveFolder;
     }
+    get exclude(): string[] {
+        return this.configData.exclude;
+    }
+
     buildDirectory(multiProject: boolean, workspaceFolder?: vscode.ConfigurationScope): string {
         if (multiProject && this.isDefaultValue('buildDirectory', workspaceFolder)) {
             return '${sourceDirectory}/build';
@@ -596,6 +601,7 @@ export class ConfigurationReader implements vscode.Disposable {
     private readonly emitters: EmittersOf<ExtensionConfigurationSettings> = {
         autoSelectActiveFolder: new vscode.EventEmitter<boolean>(),
         defaultActiveFolder: new vscode.EventEmitter<string | null>(),
+        exclude: new vscode.EventEmitter<string[]>(),
         cmakePath: new vscode.EventEmitter<string>(),
         buildDirectory: new vscode.EventEmitter<string>(),
         installPrefix: new vscode.EventEmitter<string | null>(),

src/extension.ts

@@ -15,7 +15,7 @@ import { CMakeCache } from '@cmt/cache';
 import { CMakeProject, ConfigureType, ConfigureTrigger, DiagnosticsConfiguration, DiagnosticsSettings } from '@cmt/cmakeProject';
 import { ConfigurationReader, getSettingsChangePromise, TouchBarConfig } from '@cmt/config';
 import { CppConfigurationProvider, DiagnosticsCpptools } from '@cmt/cpptools';
-import { ProjectController, FolderProjectType} from '@cmt/projectController';
+import { ProjectController, AfterAcknowledgeFolderType} from '@cmt/projectController';
 
 import {
     SpecialKits,
@@ -162,13 +162,15 @@ export class ExtensionManager implements vscode.Disposable {
 
         this.onDidChangeActiveTextEditorSub = vscode.window.onDidChangeActiveTextEditor(e => this.onDidChangeActiveTextEditor(e), this);
 
-        this.projectController.onAfterAddFolder(async (folderProjectMap: FolderProjectType) => {
-            const folder: vscode.WorkspaceFolder = folderProjectMap.folder;
-            if (this.projectController.numOfWorkspaceFolders === 1) {
-                // First folder added
-                await this.updateActiveProject(folder);
-            } else {
-                await this.initActiveProject();
+        this.projectController.onAfterAcknowledgeFolder(async (obj: AfterAcknowledgeFolderType) => {
+            const folder: vscode.WorkspaceFolder = obj.folderProjectType.folder;
+            if (obj.isInitial) {
+                if (this.projectController.numOfWorkspaceFolders === 1) {
+                    // First folder added
+                    await this.updateActiveProject(folder);
+                } else {
+                    await this.initActiveProject();
+                }
             }
             await setContextAndStore(multiProjectModeKey, this.projectController.hasMultipleProjects);
             this.projectOutline.addFolder(folder);
@@ -177,7 +179,8 @@ export class ExtensionManager implements vscode.Disposable {
                 this.codeModelUpdateSubs.delete(folder.uri.fsPath);
             }
             const subs: vscode.Disposable[] = [];
-            for (const project of folderProjectMap.projects) {
+            for (const project of obj.folderProjectType.projects) {
+                project.addTestExplorerRoot(project.folderPath);
                 subs.push(project.onCodeModelChanged(FireLate, () => this.updateCodeModel(project)));
                 subs.push(project.onTargetNameChanged(FireLate, () => this.updateCodeModel(project)));
                 subs.push(project.onLaunchTargetNameChanged(FireLate, () => this.updateCodeModel(project)));
@@ -187,22 +190,23 @@ export class ExtensionManager implements vscode.Disposable {
             }
         });
 
-        this.projectController.onBeforeRemoveFolder(async projects => {
+        this.projectController.onBeforeIgnoreFolder(async projects => {
             for (const project of projects) {
                 project.removeTestExplorerRoot(project.folderPath);
             }
         });
 
-        this.projectController.onAfterRemoveFolder(async folder => {
+        this.projectController.onAfterIgnoreFolder(async folder => {
             console.assert((vscode.workspace.workspaceFolders === undefined && this.projectController.numOfWorkspaceFolders === 0) ||
                 (vscode.workspace.workspaceFolders !== undefined && vscode.workspace.workspaceFolders.length === this.projectController.numOfWorkspaceFolders));
             this.codeModelUpdateSubs.get(folder.uri.fsPath)?.forEach(sub => sub.dispose());
             this.codeModelUpdateSubs.delete(folder.uri.fsPath);
-            if (!vscode.workspace.workspaceFolders?.length) {
+            const workspaceFolders = this.projectController.getCMakeFoldersWithProject();
+            if (workspaceFolders.length === 0) {
                 await this.updateActiveProject(undefined);
             } else {
                 if (this.activeFolderPath() === folder.uri.fsPath) {
-                    await this.updateActiveProject(vscode.workspace.workspaceFolders[0]);
+                    await this.updateActiveProject(workspaceFolders[0]);
                 } else {
                     this.setupSubscriptions();
                 }
@@ -275,10 +279,9 @@ export class ExtensionManager implements vscode.Disposable {
 
         let isMultiProject = false;
         if (vscode.workspace.workspaceFolders) {
-            await this.projectController.loadAllProjects();
+            await this.projectController.loadAllFolders();
             isMultiProject = this.projectController.hasMultipleProjects;
             await setContextAndStore(multiProjectModeKey, isMultiProject);
-            this.projectOutline.addAllCurrentFolders();
             if (this.workspaceConfig.autoSelectActiveFolder && isMultiProject) {
                 this.statusBar.setAutoSelectActiveProject(true);
             }
@@ -296,6 +299,7 @@ export class ExtensionManager implements vscode.Disposable {
             telemetryProperties['autoSelectActiveFolder'] = `${this.workspaceConfig.autoSelectActiveFolder}`;
         }
         telemetryProperties['enableLanguageServices'] = `${this.workspaceConfig.enableLanguageServices}`;
+        telemetryProperties['excludedFoldersCount'] = `${this.workspaceConfig.exclude.length}`;
         telemetry.sendOpenTelemetry(telemetryProperties);
 
         // do these last
@@ -355,7 +359,7 @@ export class ExtensionManager implements vscode.Disposable {
     projectStatus = new ProjectStatus();
 
     // NOTE: (from sidebar) The project controller manages all the projects in the workspace
-    public readonly projectController = new ProjectController(this.extensionContext, this.projectStatus);
+    public readonly projectController = new ProjectController(this.extensionContext, this.projectStatus, this.workspaceConfig);
     /**
      * The status bar controller
      */
@@ -685,7 +689,6 @@ export class ExtensionManager implements vscode.Disposable {
             return;
         }
         const rootFolder: vscode.WorkspaceFolder = project.workspaceFolder;
-        project.addTestExplorerRoot(project.folderPath);
         // Scan for kits even under presets mode, so we can create presets from compilers.
         // Silent re-scan when detecting a breaking change in the kits definition.
         // Do this only for the first folder, to avoid multiple rescans taking place in a multi-root workspace.
@@ -774,9 +777,10 @@ export class ExtensionManager implements vscode.Disposable {
 
     private async initActiveProject(): Promise<CMakeProject | undefined> {
         let folder: vscode.WorkspaceFolder | undefined;
-        if (vscode.workspace.workspaceFolders && vscode.window.activeTextEditor && this.workspaceConfig.autoSelectActiveFolder) {
+        const workspaceFoldersWithProjects = this.projectController.getCMakeFoldersWithProject();
+        if (workspaceFoldersWithProjects.length > 0 && vscode.window.activeTextEditor && this.workspaceConfig.autoSelectActiveFolder) {
             folder = vscode.workspace.getWorkspaceFolder(vscode.window.activeTextEditor.document.uri);
-            await this.updateActiveProject(folder ?? vscode.workspace.workspaceFolders[0], folder ? vscode.window.activeTextEditor : undefined);
+            await this.updateActiveProject(folder ?? workspaceFoldersWithProjects[0], folder ? vscode.window.activeTextEditor : undefined);
             return this.getActiveProject();
         }
         const activeFolder = this.extensionContext.workspaceState.get<string>('activeFolder');
@@ -789,11 +793,11 @@ export class ExtensionManager implements vscode.Disposable {
         if (defaultActiveFolder) {
             // do not use the active text editor for updating active project
             activeTextEditor = undefined;
-            folder = vscode.workspace.workspaceFolders!.find(candidate => candidate.uri.path.endsWith(defaultActiveFolder));
+            folder = workspaceFoldersWithProjects!.find(candidate => candidate.uri.path.endsWith(defaultActiveFolder));
         }
 
         if (!folder) {
-            folder = vscode.workspace.workspaceFolders![0];
+            folder = workspaceFoldersWithProjects![0];
         }
         await this.updateActiveProject(folder, activeTextEditor);
         return this.getActiveProject();