Skip to content

Add support for diagnostic tags, and use them for mergeDefaultSetupAndUserConfigs #4011

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mbg merged 5 commits into from
Jul 15, 2026
Merged

Add support for diagnostic tags, and use them for mergeDefaultSetupAndUserConfigs #4011

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
8bc3738
Add `DiagnosticTag` type and `tags` property
mbg Jul 14, 2026
358d197
Refactor `source` type into `DiagnosticSource`
mbg Jul 14, 2026
8aa21b4
Split `DiagnosticMessage` into `BaseDiagnosticMessage`
mbg Jul 14, 2026
f3d4739
Add `tags` parameter to `makeTelemetryDiagnostic`
mbg Jul 14, 2026
405f67d
Add `internal-error` tags to diagnostics in `mergeDefaultSetupAndUser…
mbg Jul 14, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Split DiagnosticMessage into BaseDiagnosticMessage
  • Loading branch information
@mbg
mbg committed Jul 14, 2026
commit 8aa21b44a3cdb669ea4faa767edd99ddc22cbd90
47 changes: 32 additions & 15 deletions src/diagnostics.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,30 +12,39 @@ import { getCodeQLDatabasePath } from "./util";
*/
export type DiagnosticTag = "internal-error";

/** Optional information about the origin of a diagnostic. */
export type DiagnosticSourceOptions = {
/**
* Name of the CodeQL extractor. This is used to identify which tool component the reporting
* descriptor object should be nested under in SARIF.
*/
extractorName?: string;
/** An array of tags for the diagnostic. */
tags?: DiagnosticTag[];
};

/** Represents information about the origin of a diagnostic. */
export interface DiagnosticSource {
export type DiagnosticSource = {
/**
* An identifier under which it makes sense to group this diagnostic message.
* This is used to build the SARIF reporting descriptor object.
*/
id: string;
/** Display name for the ID. This is used to build the SARIF reporting descriptor object. */
name: string;
/**
* Name of the CodeQL extractor. This is used to identify which tool component the reporting
* descriptor object should be nested under in SARIF.
*/
extractorName?: string;
/** An array of tags for the diagnostic. */
tags?: DiagnosticTag[];
}
} & DiagnosticSourceOptions;

/** Represents a diagnostic message for the tool status page, etc. */
export interface DiagnosticMessage {
/**
* Represents a diagnostic message for the tool status page, etc.
*
* Unlike {@link DiagnosticMessage}, properties which can automatically
* be populated are optional in this type.
*/
export type DiagnosticMessageOptions = {
/** ISO 8601 timestamp */
timestamp: string;
timestamp?: string;
/** Information about the origin of the diagnostic. */
source: DiagnosticSource;
source?: DiagnosticSourceOptions;
/** GitHub flavored Markdown formatted message. Should include inline links to any help pages. */
markdownMessage?: string;
/** Plain text message. Used by components where the string processing needed to support Markdown is cumbersome. */
Expand Down Expand Up @@ -65,7 +74,15 @@ export interface DiagnosticMessage {
};
/** Structured metadata about the diagnostic message */
attributes?: { [key: string]: any };
}
};

/** Represents a diagnostic message for the tool status page, etc. */
export type DiagnosticMessage = DiagnosticMessageOptions & {
/** ISO 8601 timestamp */
timestamp: string;
/** Information about the origin of the diagnostic. */
source: DiagnosticSource;
};

/** Represents a diagnostic message that has not yet been written to the database. */
interface UnwrittenDiagnostic {
Expand Down Expand Up @@ -102,7 +119,7 @@ let diagnosticCounter = 0;
export function makeDiagnostic(
id: string,
name: string,
data: Partial<DiagnosticMessage> | undefined = undefined,
data: DiagnosticMessageOptions | undefined = undefined,
): DiagnosticMessage {
return {
...data,
Expand Down