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

Interface: FormatterOptions

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

includeContext?

optional includeContext: boolean;
Defined in: src/mantle/output/formatters.ts:89

includeMetadata?

optional includeMetadata: boolean;
Defined in: src/mantle/output/formatters.ts:90

maxContextLength?

optional maxContextLength: number;
Defined in: src/mantle/output/formatters.ts:92

prettyPrint?

optional prettyPrint: boolean;
Defined in: src/mantle/output/formatters.ts:91

toolName?

optional toolName: string;
Defined in: src/mantle/output/formatters.ts:93

toolVersion?

optional toolVersion: string;
Defined in: src/mantle/output/formatters.ts:94