dmd.sarif

struct ToolInformation;

Contains information about the tool used for analysis in SARIF reports.

string name;

Name of the tool.

string toolVersion;

Version of the tool.

nothrow string toJson();

Converts the tool information to a JSON string.

Returns:

• A JSON representation of the tool's name and version.

nothrow string intToString(int value);

Converts an integer to a string.

Parameters:

int value

The integer value to convert.

Returns:

A string representation of the integer.

struct SarifResult;

Represents a SARIF result containing a rule ID, message, and location.

string ruleId;

Rule identifier.

string message;

Error or warning message.

string uri;

URI of the affected file.

int startLine;

Line number where the issue occurs.

int startColumn;

Column number where the issue occurs.

nothrow string toJson();

Converts the SARIF result to a JSON string.

Returns:

• A JSON string representing the SARIF result, including the rule ID, message, and location.

nothrow void addSarifDiagnostic(const SourceLoc loc, const(char)* format, va_list ap, ErrorKind kind);

Adds a SARIF diagnostic entry to the diagnostics list.

Formats a diagnostic message and appends it to the global diagnostics array, allowing errors, warnings, or other diagnostics to be captured in SARIF format.

Parameters:

SourceLoc loc	The location in the source code where the diagnostic was generated (includes file, line, and column).
const(char)* format	The printf-style format string for the diagnostic message.
va_list ap	The variadic argument list containing values to format into the diagnostic message.
ErrorKind kind	The type of diagnostic, indicating whether it is an error, warning, deprecation, etc.

struct SarifReport;

Represents a SARIF report containing tool information, invocation, and results.

ToolInformation tool;

Information about the analysis tool.

Invocation invocation;

Execution information.

SarifResult[] results;

List of SARIF results (errors, warnings, etc.).

nothrow string toJson();

Converts the SARIF report to a JSON string.

Returns:

• A JSON string representing the SARIF report, including the tool information, invocation, and results.

struct Invocation;

Represents invocation information for the analysis process.

bool executionSuccessful;

Whether the execution was successful.

nothrow string toJson();

Converts the invocation information to a JSON string.

Returns:

• A JSON representation of the invocation status.

nothrow string formatErrorMessage(const(char)* format, va_list ap);

Formats an error message using a format string and a variable argument list.

Parameters:

const(char)* format	The format string to use.
va_list ap	A variable argument list for the format string.

Returns:

A formatted error message string.

nothrow string errorKindToString(ErrorKind kind);

Converts an ErrorKind value to a SARIF-compatible string representation for the severity level.

Parameters:

ErrorKind kind

The ErrorKind value to convert (e.g., error, warning, deprecation).

Returns:

A SARIF-compatible string representing the ErrorKind level, such as "error" or "warning".

nothrow void generateSarifReport(bool executionSuccessful);

Generates a SARIF (Static Analysis Results Interchange Format) report and prints it to stdout.

This function constructs a JSON-formatted SARIF report that includes information about the tool used (such as compiler version and URI), the invocation status (indicating whether the execution was successful), and a detailed array of diagnostics (results) when executionSuccessful is set to false. Each diagnostic entry in the results array contains the rule identifier (ruleId), a text message describing the issue (message), the severity level (level), and the location of the issue in the source code, including the file path, line number, and column number. The SARIF report adheres to the SARIF 2.1.0 standard.

Parameters:

bool executionSuccessful

true for an empty results array; false for detailed errors.

Throws:

This function is marked as nothrow and does not throw exceptions.

See Also:

SARIF 2.1.0 schema