Interface SarifResult

SARIF types for conversion

interface SarifResult {
    level:
        | "error"
        | "warning"
        | "note"
        | "none";
    locations: {
        physicalLocation: {
            artifactLocation: {
                uri: string;
            };
            region: {
                startColumn: number;
                startLine: number;
            };
        };
    }[];
    message: {
        text: string;
    };
    properties?: {
        category?: string;
        detectorId?: string;
        docURL?: string;
        extraDescription?: string;
        severity?: string;
        suggestion?: string;
    };
    ruleId: string;
}

Properties

level locations message properties? ruleId

Properties

level

level:
    | "error"
    | "warning"
    | "note"
    | "none"

locations

locations: {
    physicalLocation: {
        artifactLocation: {
            uri: string;
        };
        region: {
            startColumn: number;
            startLine: number;
        };
    };
}[]

message

message: {
    text: string;
}

Optionalproperties

properties?: {
    category?: string;
    detectorId?: string;
    docURL?: string;
    extraDescription?: string;
    severity?: string;
    suggestion?: string;
}

ruleId

ruleId: string

Settings

Member Visibility

On This Page

Properties