Function: formatDiagnostic()¶

formatDiagnostic(diagnostic, options): string

Defined in: core/src/utils/diagnostic.ts:89

Format a diagnostic for display.

Parameters¶

diagnostic¶

Diagnostic

Diagnostic to format

options¶

FormatDiagnosticOptions = {}

Formatting options

Returns¶

string

Formatted string

Example¶

const diagnostic = {
  message: 'Missing required field: id',
  severity: 'error',
  location: { file: 'project.prs', line: 5, column: 3 },
  code: 'E001',
  source: 'meta-validator'
};

formatDiagnostic(diagnostic)
// 'project.prs:5:3 - error E001: Missing required field: id'

formatDiagnostic(diagnostic, { color: true })
// '\x1b[31mproject.prs:5:3 - error E001: Missing required field: id\x1b[0m'