Skip to main content

Overview

The ReportGenerator class formats scan findings into beautiful, readable console reports.

Constructor

Example:

Methods

generateReport(directory, findings, filesScanned)

Generates a formatted privacy scan report.
Parameters:
  • directory (string): Directory that was scanned
  • findings (Finding[]): Array of findings
  • filesScanned (number): Number of files scanned
Returns: Formatted report string Example:

Usage Example

Complete Scan with Report

Report Format

The generated report includes:
  • Header: Privacy Scan Report title
  • Summary: Directory, timestamp, files scanned, issues found, privacy grade
  • Issue Listings: Grouped by severity with details
  • Recommendations: Actionable advice for each issue

Next Steps

Interpreting Results

Learn to read scan reports

Privacy Grading

Understand the grading system