Prepend cmake to our diagnostics (#4766)

* prepend 'cmake' in diagnostics source to make it more obvious where the diagnostic is coming from

* update changelog

* prepend 'cmake' in diagnostics source to make it more obvious where the diagnostic is coming from

* update changelog

* fix tests

* fix test

Author: gcampbell-msft

CHANGELOG.md

@@ -21,6 +21,7 @@ Improvements:
 - Use environment variables from `cmake.environment` and `cmake.configureEnvironment` when expanding `$penv{}` macros in CMake Presets `include` paths. [#3578](https://github.com/microsoft/vscode-cmake-tools/issues/3578)
 - Allow preset modification commands to target CMakeUserPresets.json. The target file is determined by the focused editor, or by prompting the user when both files exist. [#4564](https://github.com/microsoft/vscode-cmake-tools/issues/4564)
 - Display info tooltip when hovering over CMake policy identifiers (e.g., `CMP0177`), showing the CMake version that introduced the policy, a short description, and a link to the official documentation. [#4544](https://github.com/microsoft/vscode-cmake-tools/issues/4544)
+- Append `cmake` to diagnostics that this extension contributes to the Problems Pane. [PR #4766](https://github.com/microsoft/vscode-cmake-tools/pull/4766)
 
 Bug Fixes:
 - Fix configure/build sometimes using stale preset values when unsaved changes to included preset files are auto-saved before configure. The extension now explicitly refreshes presets from disk after saving, instead of relying solely on the asynchronous file watcher. [#4502](https://github.com/microsoft/vscode-cmake-tools/issues/4502)

src/diagnostics/build.ts

@@ -134,7 +134,7 @@ export class CompileOutputConsumer implements OutputConsumer {
                 }
 
                 const diag = new vscode.Diagnostic(raw_diag.location, raw_diag.message, severity);
-                diag.source = source;
+                diag.source = `cmake ${source}`;
                 if (raw_diag.code) {
                     diag.code = raw_diag.code;
                 }
@@ -167,7 +167,7 @@ export class CompileOutputConsumer implements OutputConsumer {
                 }
 
                 const diag = new vscode.Diagnostic(raw_diag.location, raw_diag.message, severity);
-                diag.source = name;
+                diag.source = `cmake ${name}`;
                 if (raw_diag.code) {
                     diag.code = raw_diag.code;
                 }

src/diagnostics/cmake.ts

@@ -139,7 +139,8 @@ export class CMakeOutputConsumer extends CommandConsumer {
                         Error: vscode.DiagnosticSeverity.Error
                     };
                     const vsdiag = new vscode.Diagnostic(new vscode.Range(lineno, 0, lineno, 9999), full, diagmap[level]);
-                    vsdiag.source = command ? `CMake (${command})` : 'CMake';
+                    vsdiag.source = 'cmake';
+                    vsdiag.code = command ? command : undefined;
                     vsdiag.relatedInformation = [];
                     const filepath = util.resolvePath(filename, this.sourceDir);
                     this._errorState.diag = {

src/presets/presetsController.ts

@@ -1566,7 +1566,7 @@ export class PresetsController implements vscode.Disposable {
             const diagnostic: Diagnostic = {
                 severity: DiagnosticSeverity.Error,
                 message: error[0],
-                source: error[1],
+                source: `cmake ${error[1]}`,
                 range: new Range(new Position(0, 0), new Position(0, 0))    // TODO in the future we can add the range of the error - parse originalPresetsFile
             };
             // avoid duplicate diagnostics

test/unit-tests/diagnostics.test.ts

@@ -80,7 +80,8 @@ suite('Diagnostics', () => {
         const diag = consumer.diagnostics[0];
         expect(diag.filepath).to.eq('dummyPath/CMakeLists.txt');
         expect(diag.diag.severity).to.eq(vscode.DiagnosticSeverity.Warning);
-        expect(diag.diag.source).to.eq('CMake (message)');
+        expect(diag.diag.source).to.eq('cmake');
+        expect(diag.diag.code).to.eq('message');
         expect(diag.diag.message).to.match(/I am a warning!$/);
         expect(diag.diag.range.start.line).to.eq(13);  // Line numbers are one-based
     });
@@ -96,7 +97,8 @@ suite('Diagnostics', () => {
         const diag = consumer.diagnostics[0];
         expect(diag.filepath).to.eq('dummyPath/CMakeLists.txt');
         expect(diag.diag.severity).to.eq(vscode.DiagnosticSeverity.Warning);
-        expect(diag.diag.source).to.eq('CMake (message)');
+        expect(diag.diag.source).to.eq('cmake');
+        expect(diag.diag.code).to.eq('message');
         expect(diag.diag.message).to.match(/I am deprecated!$/);
         expect(diag.diag.range.start.line).to.eq(13);  // Line numbers are one-based
     });
@@ -122,8 +124,10 @@ suite('Diagnostics', () => {
         expect(error.diag.severity).to.eq(vscode.DiagnosticSeverity.Error);
         expect(warning.diag.range.start.line).to.eq(13);
         expect(error.diag.range.start.line).to.eq(12);
-        expect(warning.diag.source).to.eq('CMake (message)');
-        expect(error.diag.source).to.eq('CMake (some_error_function)');
+        expect(warning.diag.source).to.eq('cmake');
+        expect(warning.diag.code).to.eq('message');
+        expect(error.diag.source).to.eq('cmake');
+        expect(error.diag.code).to.eq('some_error_function');
         expect(warning.diag.message).to.match(/I am a warning!$/);
         expect(error.diag.message).to.match(/I am an error!$/);
     });
@@ -144,7 +148,8 @@ suite('Diagnostics', () => {
         expect(warning.diag.severity).to.eq(vscode.DiagnosticSeverity.Warning);
         expect(warning.diag.message).to.match(/I'm an inner warning$/);
         expect(warning.diag.range.start.line).to.eq(14);
-        expect(warning.diag.source).to.eq('CMake (message)');
+        expect(warning.diag.source).to.eq('cmake');
+        expect(warning.diag.code).to.eq('message');
     });
     test('Parse Author Warnings', () => {
         const error_output = [
@@ -163,7 +168,8 @@ suite('Diagnostics', () => {
         expect(warning.diag.severity).to.eq(vscode.DiagnosticSeverity.Warning);
         expect(warning.diag.message).to.match(/I'm an inner warning$/);
         expect(warning.diag.range.start.line).to.eq(14);
-        expect(warning.diag.source).to.eq('CMake (message)');
+        expect(warning.diag.source).to.eq('cmake');
+        expect(warning.diag.code).to.eq('message');
     });
     test('Parse error without command name', () => {
         const error_output = [
@@ -179,7 +185,7 @@ suite('Diagnostics', () => {
         const diag = consumer.diagnostics[0];
         expect(diag.filepath).to.eq('dummyPath/CMakeLists.txt');
         expect(diag.diag.severity).to.eq(vscode.DiagnosticSeverity.Error);
-        expect(diag.diag.source).to.eq('CMake');
+        expect(diag.diag.source).to.eq('cmake');
         expect(diag.diag.range.start.line).to.eq(4);
     });
     test('Populate a diagnostic collection', () => {