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

Interface: ScanMetadata

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

branch?

optional branch: string;
Defined in: src/shield/output/formatters.ts:79

buildUrl?

optional buildUrl: string;
Defined in: src/shield/output/formatters.ts:84

ci?

optional ci: string;
Defined in: src/shield/output/formatters.ts:82

commit?

optional commit: string;
Defined in: src/shield/output/formatters.ts:80

pipelineId?

optional pipelineId: string;
Defined in: src/shield/output/formatters.ts:85

projectName?

optional projectName: string;
Defined in: src/shield/output/formatters.ts:78

repository?

optional repository: string;
Defined in: src/shield/output/formatters.ts:81

triggeredBy?

optional triggeredBy: string;
Defined in: src/shield/output/formatters.ts:83