Skip to content

PromptScript API


Function: formatValidationResult()

formatValidationResult(result, options): string

Defined in: validator/src/format.ts:162

Format a complete validation result for display.

Parameters

result

ValidationResult

Validation result to format

options

FormatValidationOptions = {}

Formatting options

Returns

string

Formatted string with summary

Example

const result = validator.validate(ast);
console.log(formatValidationResult(result, { color: true }));
// ✖ 2 errors, ⚠ 1 warning
// project.prs:1:1 - error: Missing required @meta.id field
// ...