Skip to main content
Dotset CLI API Documentation / index / ScanResult

Interface: ScanResult

Defined in: src/shield/output/formatters.ts:56 Output Formatting Module Format scan results in multiple output formats for CI/CD integration.

Example

import { format, formatSARIF, formatMarkdown } from '@dotsetlabs/cli';

// Format as SARIF for GitHub Code Scanning
const sarif = format(scanResult, 'sarif');
fs.writeFileSync('results.sarif', sarif);

// Format as Markdown for PR comments
const markdown = formatMarkdown(scanResult, { includeContext: true });

// Format as JSON for API consumption
const json = format(scanResult, 'json', { prettyPrint: true });

// Get available formats
const formats = getSupportedFormats();
// ['text', 'json', 'sarif', 'csv', 'xml', 'junit', 'gitlab', 'github', 'markdown']

Properties

duration

duration: number;
Defined in: src/shield/output/formatters.ts:59

findings

findings: Finding[];
Defined in: src/shield/output/formatters.ts:62

metadata?

optional metadata: ScanMetadata;
Defined in: src/shield/output/formatters.ts:64

scanId

scanId: string;
Defined in: src/shield/output/formatters.ts:57

success

success: boolean;
Defined in: src/shield/output/formatters.ts:60

summary

summary: ScanSummary;
Defined in: src/shield/output/formatters.ts:63

timestamp

timestamp: string;
Defined in: src/shield/output/formatters.ts:58

totalFindings

totalFindings: number;
Defined in: src/shield/output/formatters.ts:61