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

Interface: Finding

Defined in: src/shield/output/formatters.ts:37 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

category?

optional category: string;
Defined in: src/shield/output/formatters.ts:51

column?

optional column: number;
Defined in: src/shield/output/formatters.ts:45

confidence?

optional confidence: number;
Defined in: src/shield/output/formatters.ts:52

context?

optional context: string;
Defined in: src/shield/output/formatters.ts:48

endColumn?

optional endColumn: number;
Defined in: src/shield/output/formatters.ts:47

endLine?

optional endLine: number;
Defined in: src/shield/output/formatters.ts:46

file?

optional file: string;
Defined in: src/shield/output/formatters.ts:43

id

id: string;
Defined in: src/shield/output/formatters.ts:38

line?

optional line: number;
Defined in: src/shield/output/formatters.ts:44

message

message: string;
Defined in: src/shield/output/formatters.ts:42

metadata?

optional metadata: Record<string, unknown>;
Defined in: src/shield/output/formatters.ts:53

patternName

patternName: string;
Defined in: src/shield/output/formatters.ts:40

redactedValue?

optional redactedValue: string;
Defined in: src/shield/output/formatters.ts:49

ruleId?

optional ruleId: string;
Defined in: src/shield/output/formatters.ts:50

severity

severity: FindingSeverity;
Defined in: src/shield/output/formatters.ts:41

type

type: string;
Defined in: src/shield/output/formatters.ts:39