formatFinding()

Format a single review finding as Markdown.

Usage

import { formatFinding } from 'ai-code-reviewer-plus'
import type { ReviewFinding } from 'ai-code-reviewer-plus'

const finding: ReviewFinding = {
  ruleId: 'SEC-001',
  severity: 'BLOCKER',
  dimension: 'security',
  title: 'XSS vulnerability',
  description: 'User input unsanitized',
  file: 'src/auth.ts',
  line: 45,
  fix: 'Sanitize input before rendering',
  confidence: 'high'
}

const markdown = formatFinding(finding)

Parameters

finding: ReviewFinding

Returns

string  // Markdown formatted output

Related Functions

• formatReviewReport() — Full Markdown report
• formatDiffSummary() — Diff summary
• formatDuration() — Duration formatting

Related Types

• ReviewFinding type — Type definition