Add command to clear build diagnostics from Problems pane (#4691)

* Initial plan

* Add command to clear build diagnostics from Problems pane

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

* Add unit test for clearAll diagnostic collections

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

* Update changelog to link PR #4691 instead of issue for feature

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

---------

Co-authored-by: copilot-swe-agent[bot] <[email protected]>
Co-authored-by: snehara99 <[email protected]>

Author: Copilot

CHANGELOG.md

@@ -4,6 +4,7 @@
 
 Features:
 - 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)
 
 Bug Fixes:
 

package.json

@@ -289,6 +289,12 @@
         "when": "cmake:enableFullFeatureSet",
         "category": "CMake"
       },
+      {
+        "command": "cmake.clearBuildDiagnostics",
+        "title": "%cmake-tools.command.cmake.clearBuildDiagnostics.title%",
+        "when": "cmake:enableFullFeatureSet",
+        "category": "CMake"
+      },
       {
         "command": "cmake.selectActiveFolder",
         "title": "%cmake-tools.command.cmake.selectActiveFolder.title%",

package.nls.json

@@ -21,6 +21,7 @@
         ]
     },
     "cmake-tools.command.cmake.logDiagnostics.title": "Log Diagnostics",
+    "cmake-tools.command.cmake.clearBuildDiagnostics.title": "Clear Build Diagnostics",
     "cmake-tools.command.cmake.editKits.title": "Edit User-Local CMake Kits",
     "cmake-tools.command.cmake.scanForKits.title": "Scan for Kits",
     "cmake-tools.command.cmake.scanForCompilers.title": "Scan for Compilers",

src/diagnostics/collections.ts

@@ -30,6 +30,15 @@ class LazyCollection implements vscode.Disposable {
         }
         this._collection = undefined;
     }
+
+    /**
+     * Clear the diagnostics in the collection
+     */
+    clear() {
+        if (this._collection) {
+            this._collection.clear();
+        }
+    }
 }
 
 /**
@@ -66,6 +75,15 @@ class Collections {
         this._build.dispose();
         this._presets.dispose();
     }
+
+    /**
+     * Clear all diagnostics from all collections
+     */
+    clearAll() {
+        this._cmake.clear();
+        this._build.clear();
+        this._presets.clear();
+    }
 }
 
 export const collections = new Collections();

src/extension.ts

@@ -50,6 +50,7 @@ import { getCMakeExecutableInformation } from '@cmt/cmakeExecutable';
 import { DebuggerInformation, getDebuggerPipeName } from '@cmt/debug/cmakeDebugger/debuggerConfigureDriver';
 import { DebugConfigurationProvider, DynamicDebugConfigurationProvider } from '@cmt/debug/cmakeDebugger/debugConfigurationProvider';
 import { deIntegrateTestExplorer } from "@cmt/ctest";
+import collections from '@cmt/diagnostics/collections';
 import { LanguageServiceData } from './languageServices/languageServiceData';
 
 nls.config({ messageFormat: nls.MessageFormat.bundle, bundleFormat: nls.BundleFormat.standalone })();
@@ -1905,6 +1906,11 @@ export class ExtensionManager implements vscode.Disposable {
         output.show();
     }
 
+    async clearBuildDiagnostics() {
+        telemetry.logEvent("clearBuildDiagnostics");
+        collections.clearAll();
+    }
+
     activeCMakeWorkspaceFolder(): vscode.WorkspaceFolder | undefined {
         return this.getActiveProject()?.workspaceFolder;
     }
@@ -2411,6 +2417,7 @@ async function setup(context: vscode.ExtensionContext, progress?: ProgressHandle
         'openSettings',
         'viewLog',
         'logDiagnostics',
+        'clearBuildDiagnostics',
         'compileFile',
         'selectWorkspace',
         'tasksBuildCommand',

test/unit-tests/diagnostics.test.ts

@@ -13,6 +13,7 @@ import { ExtensionConfigurationSettings, ConfigurationReader } from '../../src/c
 import { platformPathEquivalent, resolvePath } from '@cmt/util';
 import { CMakeOutputConsumer } from '@cmt/diagnostics/cmake';
 import { populateCollection } from '@cmt/diagnostics/util';
+import collections from '@cmt/diagnostics/collections';
 import { getTestResourceFilePath } from '@test/util';
 
 function feedLines(consumer: OutputConsumer, output: string[], error: string[]) {
@@ -975,4 +976,32 @@ suite('Diagnostics', () => {
         expect(all2.message).to.eq('The full include-list:\n#include "array.h"             // for ARRAY_SIZE');
         expect(all2.severity).to.eq('note');
     });
+
+    test('clearAll clears all diagnostic collections', () => {
+        // Add some diagnostics to each collection
+        const testUri = vscode.Uri.file('/test/file.cpp');
+        const testDiagnostic = new vscode.Diagnostic(
+            new vscode.Range(0, 0, 0, 10),
+            'Test diagnostic',
+            vscode.DiagnosticSeverity.Error
+        );
+
+        // Populate the collections
+        collections.cmake.set(testUri, [testDiagnostic]);
+        collections.build.set(testUri, [testDiagnostic]);
+        collections.presets.set(testUri, [testDiagnostic]);
+
+        // Verify diagnostics were added
+        expect(collections.cmake.has(testUri)).to.be.true;
+        expect(collections.build.has(testUri)).to.be.true;
+        expect(collections.presets.has(testUri)).to.be.true;
+
+        // Clear all collections
+        collections.clearAll();
+
+        // Verify all collections are cleared
+        expect(collections.cmake.has(testUri)).to.be.false;
+        expect(collections.build.has(testUri)).to.be.false;
+        expect(collections.presets.has(testUri)).to.be.false;
+    });
 });