Add support for custom build problem matchers in CMake Tools (#4760)

* Add support for custom build problem matchers in CMake Tools

- Introduced `cmake.additionalBuildProblemMatchers` setting to allow users to define custom problem matchers for build output.
- Implemented `CustomParser` to handle user-defined regex patterns and integrate diagnostics into the VS Code Problems pane.
- Updated documentation and tests to cover new functionality, including examples for clang-tidy, PCLint, and cppcheck formats.

* fixed regex

* updated test

---------

Co-authored-by: Hannia Valera <[email protected]>

Author: hanniavalera

CHANGELOG.md

@@ -8,6 +8,7 @@ Features:
 - Add individual CTest test nodes to the Project Outline with inline run/debug buttons, and enable debugging tests from both the Outline and Test Explorer without requiring a launch.json. [#4721](https://github.com/microsoft/vscode-cmake-tools/pull/4721)
 - Add "Delete Cache, Reconfigure and Build" command that chains cache deletion, reconfiguration, and build into a single action. [#4723](https://github.com/microsoft/vscode-cmake-tools/pull/4723)
 - Add "Set Build and Launch/Debug Target" command that sets both the build target and launch target simultaneously. [#4732](https://github.com/microsoft/vscode-cmake-tools/pull/4732)
+- Add `cmake.additionalBuildProblemMatchers` setting to define custom problem matchers for build output. Supports tools like clang-tidy, PCLint Plus, cppcheck, or custom scripts integrated via `add_custom_command`/`add_custom_target`. [#4077](https://github.com/microsoft/vscode-cmake-tools/issues/4077)
 
 Improvements:
 - Make "CMake: Add ... Preset" commands available in the command palette when `cmake.useCMakePresets` is set to `auto`, even before a CMakePresets.json file exists. [#4401](https://github.com/microsoft/vscode-cmake-tools/issues/4401)

docs/cmake-settings.md

@@ -49,6 +49,7 @@ Options that support substitution, in the table below, allow variable references
 | `cmake.emscriptenSearchDirs` | List of paths to search for Emscripten. | `[]` | no |
 | `cmake.enableAutomaticKitScan` | Enable automatic kit scanning. | `true` | no |
 | `cmake.enabledOutputParsers` | List of enabled output parsers. | `["cmake", "gcc", "gnuld", "msvc", "ghs", "diab", "iwyu"]` | no |
+| `cmake.additionalBuildProblemMatchers` | Array of user-defined problem matchers for build output. Each entry has `name`, `regexp`, and optional capture group indices (`file`, `line`, `column`, `severity`, `message`, `code`). See [Additional Build Problem Matchers](#additional-build-problem-matchers) below. | `[]` | no |
 | `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 |
@@ -149,6 +150,74 @@ Supported commands for substitution:
 |`cmake.activeBuildPresetName`|The name of the active build preset.|
 |`cmake.activeTestPresetName`|The name of the active test preset.|
 
+## Additional build problem matchers
+
+The `cmake.additionalBuildProblemMatchers` setting lets you define custom problem matchers that are applied to build output. This is useful when you integrate tools like **clang-tidy**, **PCLint Plus**, **cppcheck**, or custom scripts into your CMake build via `add_custom_command` or `add_custom_target`. Diagnostics from these tools will appear in the VS Code **Problems** pane alongside the standard compiler errors.
+
+Custom matchers run **after** the built-in parsers (`gcc`, `msvc`, `gnuld`, etc.), so they will not interfere with standard compiler diagnostics.
+
+Each matcher entry has the following properties:
+
+| Property | Type | Required | Default | Description |
+|----------|------|----------|---------|-------------|
+| `name` | string | **yes** | — | Friendly name shown as the diagnostic source in the Problems pane. |
+| `regexp` | string | **yes** | — | Regular expression applied to each build output line. |
+| `file` | integer | no | `1` | Capture group index for the file path. |
+| `line` | integer | no | `2` | Capture group index for the line number. |
+| `column` | integer | no | — | Capture group index for the column number. |
+| `severity` | integer or string | no | `"warning"` | Either a capture group index (integer) that captures `"error"`, `"warning"`, or `"info"`, or a fixed string. |
+| `message` | integer | no | `3` | Capture group index for the diagnostic message. |
+| `code` | integer | no | — | Capture group index for a diagnostic code. |
+
+### Examples
+
+**clang-tidy** (`/path/file.cpp:10:5: warning: some message [check-name]`):
+
+```json
+"cmake.additionalBuildProblemMatchers": [
+  {
+    "name": "clang-tidy",
+    "regexp": "^(.+?):(\\d+):(\\d+):\\s+(warning|error|note):\\s+(.+?)\\s*(?:\\[(.+)\\])?$",
+    "file": 1,
+    "line": 2,
+    "column": 3,
+    "severity": 4,
+    "message": 5,
+    "code": 6
+  }
+]
+```
+
+**cppcheck** (`[file.cpp:10]: (warning) message`):
+
+```json
+"cmake.additionalBuildProblemMatchers": [
+  {
+    "name": "cppcheck",
+    "regexp": "^\\[(.+?):(\\d+)\\]:\\s+\\((error|warning|style|performance|portability|information)\\)\\s+(.+)$",
+    "file": 1,
+    "line": 2,
+    "severity": 3,
+    "message": 4
+  }
+]
+```
+
+**Custom script with fixed severity** (`LINT: file.cpp:7: message`):
+
+```json
+"cmake.additionalBuildProblemMatchers": [
+  {
+    "name": "my-lint",
+    "regexp": "^LINT:\\s+(.+?):(\\d+):\\s+(.+)$",
+    "file": 1,
+    "line": 2,
+    "severity": "error",
+    "message": 3
+  }
+]
+```
+
 ## Next steps
 
 - Learn about [user vs. workspace settings](https://code.visualstudio.com/docs/getstarted/settings)

package.json

@@ -2574,6 +2574,69 @@
           ],
           "scope": "resource"
         },
+        "cmake.additionalBuildProblemMatchers": {
+          "type": "array",
+          "markdownDescription": "%cmake-tools.configuration.cmake.additionalBuildProblemMatchers.markdownDescription%",
+          "items": {
+            "type": "object",
+            "required": [
+              "name",
+              "regexp"
+            ],
+            "properties": {
+              "name": {
+                "type": "string",
+                "description": "%cmake-tools.configuration.cmake.additionalBuildProblemMatchers.name%"
+              },
+              "regexp": {
+                "type": "string",
+                "description": "%cmake-tools.configuration.cmake.additionalBuildProblemMatchers.regexp%"
+              },
+              "file": {
+                "type": "integer",
+                "description": "%cmake-tools.configuration.cmake.additionalBuildProblemMatchers.file%",
+                "default": 1
+              },
+              "line": {
+                "type": "integer",
+                "description": "%cmake-tools.configuration.cmake.additionalBuildProblemMatchers.line%",
+                "default": 2
+              },
+              "column": {
+                "type": "integer",
+                "description": "%cmake-tools.configuration.cmake.additionalBuildProblemMatchers.column%"
+              },
+              "severity": {
+                "oneOf": [
+                  {
+                    "type": "integer",
+                    "description": "%cmake-tools.configuration.cmake.additionalBuildProblemMatchers.severity.group%"
+                  },
+                  {
+                    "type": "string",
+                    "enum": [
+                      "error",
+                      "warning",
+                      "info"
+                    ],
+                    "description": "%cmake-tools.configuration.cmake.additionalBuildProblemMatchers.severity.fixed%"
+                  }
+                ]
+              },
+              "message": {
+                "type": "integer",
+                "description": "%cmake-tools.configuration.cmake.additionalBuildProblemMatchers.message%",
+                "default": 3
+              },
+              "code": {
+                "type": "integer",
+                "description": "%cmake-tools.configuration.cmake.additionalBuildProblemMatchers.code%"
+              }
+            }
+          },
+          "default": [],
+          "scope": "resource"
+        },
         "cmake.debugConfig": {
           "type": "object",
           "description": "%cmake-tools.configuration.cmake.debugConfig.description%",

package.nls.json

@@ -174,6 +174,41 @@
             "Markdown text between `` should not be translated or localized (they represent literal text) and the capitalization, spacing, and punctuation (including the ``) should not be altered."
         ]
     },
+    "cmake-tools.configuration.cmake.additionalBuildProblemMatchers.markdownDescription": {
+        "message": "Additional problem matchers for build output. Use this to surface diagnostics from tools like clang-tidy, PCLint Plus, cppcheck, or custom scripts integrated via `add_custom_command`/`add_custom_target` in CMake.\n\nEach entry defines a `name` (used as the diagnostic source label), a `regexp`, and capture group indices for `file`, `line`, `column`, `severity`, `message`, and `code`.\n\nFor example, to match clang-tidy output like `/path/file.cpp:10:5: warning: some message [check-name]`:\n```json\n[\n  {\n    \"name\": \"clang-tidy\",\n    \"regexp\": \"^(.+?):(\\\\d+):(\\\\d+):\\\\s+(warning|error|note):\\\\s+(.+?)\\\\s*(?:\\\\[(.+)\\\\])?$\",\n    \"file\": 1,\n    \"line\": 2,\n    \"column\": 3,\n    \"severity\": 4,\n    \"message\": 5,\n    \"code\": 6\n  }\n]\n```\n\nCustom matchers run **after** the built-in parsers (`gcc`, `msvc`, etc.) so they do not steal lines from built-in compilers.",
+        "comment": [
+            "Markdown text between `` should not be translated or localized (they represent literal text) and the capitalization, spacing, and punctuation (including the ``) should not be altered."
+        ]
+    },
+    "cmake-tools.configuration.cmake.additionalBuildProblemMatchers.name": "A unique name for this matcher, used as the diagnostic source label in the Problems pane.",
+    "cmake-tools.configuration.cmake.additionalBuildProblemMatchers.regexp": "The regular expression to match against each build output line.",
+    "cmake-tools.configuration.cmake.additionalBuildProblemMatchers.file": {
+        "message": "The capture group index for the file path. Defaults to `1`.",
+        "comment": [
+            "Markdown text between `` should not be translated or localized (they represent literal text) and the capitalization, spacing, and punctuation (including the ``) should not be altered."
+        ]
+    },
+    "cmake-tools.configuration.cmake.additionalBuildProblemMatchers.line": {
+        "message": "The capture group index for the line number. Defaults to `2`.",
+        "comment": [
+            "Markdown text between `` should not be translated or localized (they represent literal text) and the capitalization, spacing, and punctuation (including the ``) should not be altered."
+        ]
+    },
+    "cmake-tools.configuration.cmake.additionalBuildProblemMatchers.column": {
+        "message": "The capture group index for the column number. Optional.",
+        "comment": [
+            "Markdown text between `` should not be translated or localized (they represent literal text) and the capitalization, spacing, and punctuation (including the ``) should not be altered."
+        ]
+    },
+    "cmake-tools.configuration.cmake.additionalBuildProblemMatchers.severity.group": "The capture group index for the severity (should capture 'error', 'warning', or 'info').",
+    "cmake-tools.configuration.cmake.additionalBuildProblemMatchers.severity.fixed": "A fixed severity to apply to all matches from this pattern.",
+    "cmake-tools.configuration.cmake.additionalBuildProblemMatchers.message": {
+        "message": "The capture group index for the diagnostic message. Defaults to `3`.",
+        "comment": [
+            "Markdown text between `` should not be translated or localized (they represent literal text) and the capitalization, spacing, and punctuation (including the ``) should not be altered."
+        ]
+    },
+    "cmake-tools.configuration.cmake.additionalBuildProblemMatchers.code": "The capture group index for an optional diagnostic code.",
     "cmake-tools.configuration.cmake.debugConfig.description": "The debug configuration to use when debugging a target.",
     "cmake-tools.configuration.cmake.debugConfig.symbolSearchPath.description": "Visual Studio debugger symbol search paths.",
     "cmake-tools.configuration.cmake.debugConfig.additionalSOLibSearchPath.description": "Paths for GDB or LLDB to search for .so files.",

src/config.ts

@@ -12,6 +12,7 @@ import * as vscode from 'vscode';
 import * as nls from 'vscode-nls';
 import { CppDebugConfiguration } from '@cmt/debug/debugger';
 import { Environment } from '@cmt/environmentVariables';
+import { BuildProblemMatcherConfig } from '@cmt/diagnostics/custom';
 
 nls.config({ messageFormat: nls.MessageFormat.bundle, bundleFormat: nls.BundleFormat.standalone })();
 const localize: nls.LocalizeFunc = nls.loadMessageBundle();
@@ -234,6 +235,7 @@ export interface ExtensionConfigurationSettings {
     postRunCoverageTarget: string | null;
     coverageInfoFiles: string[];
     useFolderPropertyInBuildTargetDropdown: boolean;
+    additionalBuildProblemMatchers: BuildProblemMatcherConfig[];
 }
 
 type EmittersOf<T> = {
@@ -420,6 +422,9 @@ export class ConfigurationReader implements vscode.Disposable {
     get enableOutputParsers(): string[] | null {
         return this.configData.enabledOutputParsers;
     }
+    get additionalBuildProblemMatchers(): BuildProblemMatcherConfig[] {
+        return this.configData.additionalBuildProblemMatchers ?? [];
+    }
     get pinnedCommands(): string[] | null {
         return this.configData.pinnedCommands;
     }
@@ -692,7 +697,8 @@ export class ConfigurationReader implements vscode.Disposable {
         preRunCoverageTarget: new vscode.EventEmitter<string | null>(),
         postRunCoverageTarget: new vscode.EventEmitter<string | null>(),
         coverageInfoFiles: new vscode.EventEmitter<string[]>(),
-        useFolderPropertyInBuildTargetDropdown: new vscode.EventEmitter<boolean>()
+        useFolderPropertyInBuildTargetDropdown: new vscode.EventEmitter<boolean>(),
+        additionalBuildProblemMatchers: new vscode.EventEmitter<BuildProblemMatcherConfig[]>()
     };
 
     /**

src/diagnostics/build.ts

@@ -15,6 +15,7 @@ import * as gnu_ld from '@cmt/diagnostics/gnu-ld';
 import * as mvsc from '@cmt/diagnostics/msvc';
 import * as iar from '@cmt/diagnostics/iar';
 import * as iwyu from '@cmt/diagnostics/iwyu';
+import { CustomParser } from '@cmt/diagnostics/custom';
 import { FileDiagnostic, RawDiagnostic, RawDiagnosticParser } from '@cmt/diagnostics/util';
 import { ConfigurationReader } from '@cmt/config';
 import { fs } from '@cmt/pr';
@@ -32,7 +33,15 @@ export class Compilers {
 }
 
 export class CompileOutputConsumer implements OutputConsumer {
-    constructor(readonly config: ConfigurationReader) {}
+    readonly customParsers: Map<string, CustomParser> = new Map();
+
+    constructor(readonly config: ConfigurationReader) {
+        for (const matcherConfig of config.additionalBuildProblemMatchers ?? []) {
+            if (matcherConfig.name && matcherConfig.regexp) {
+                this.customParsers.set(matcherConfig.name, new CustomParser(matcherConfig));
+            }
+        }
+    }
 
     compilers = new Compilers();
 
@@ -42,9 +51,16 @@ export class CompileOutputConsumer implements OutputConsumer {
     }
 
     error(line: string) {
+        // Built-in parsers get first priority
         for (const cand in this.compilers) {
             if (this.compilers[cand].handleLine(line)) {
-                break;
+                return;
+            }
+        }
+        // Custom user-defined parsers run after built-ins
+        for (const [, parser] of this.customParsers) {
+            if (parser.handleLine(line)) {
+                return;
             }
         }
     }
@@ -128,6 +144,37 @@ export class CompileOutputConsumer implements OutputConsumer {
 
         await linkerHandler.finalize(arrs);
 
+        // Include diagnostics from custom user-defined parsers (always enabled)
+        for (const [name, parser] of this.customParsers) {
+            for (const raw_diag of parser.diagnostics) {
+                const filepath = await this.resolvePath(raw_diag.file, basePaths);
+                const severity = severity_of(raw_diag.severity);
+                if (severity === undefined) {
+                    continue;
+                }
+
+                const diag = new vscode.Diagnostic(raw_diag.location, raw_diag.message, severity);
+                diag.source = name;
+                if (raw_diag.code) {
+                    diag.code = raw_diag.code;
+                }
+                if (!diags_by_file.has(filepath)) {
+                    diags_by_file.set(filepath, []);
+                }
+                diag.relatedInformation = [];
+                for (const rel of raw_diag.related) {
+                    const relFilePath = vscode.Uri.file(await this.resolvePath(rel.file, basePaths));
+                    const related = new vscode.DiagnosticRelatedInformation(new vscode.Location(relFilePath, rel.location), rel.message);
+                    diag.relatedInformation.push(related);
+                }
+                diags_by_file.get(filepath)!.push(diag);
+                arrs.push({
+                    filepath,
+                    diag
+                });
+            }
+        }
+
         return arrs;
     }