woaru
Version:
Universal Project Setup Autopilot - Analyze and automatically configure development tools for ANY programming language
164 lines • 4.97 kB
TypeScript
import { QualityCheckResult, SnykResult } from '../quality/QualityRunner';
import { ProductionAudit } from '../auditor/ProductionReadinessAuditor';
import { GitDiffResult } from '../utils/GitDiffAnalyzer';
import { SecurityScanResult } from '../types/security';
import { MultiLLMReviewResult } from '../types/ai-review';
/**
* Data structure for review report generation
*/
export interface ReviewReportData {
context?: {
type: string;
description: string;
};
gitDiff: GitDiffResult;
qualityResults: QualityCheckResult[];
securityResults?: SecurityScanResult[];
snykResults?: SnykResult[];
productionAudits: ProductionAudit[];
aiReviewResults?: MultiLLMReviewResult;
currentBranch: string;
commits: string[];
}
export declare class ReviewReportGenerator {
private reportMetrics;
/**
* Generate markdown report with standardized filename
* @param data - Review report data containing all analysis results
* @param outputPath - Optional output path, will use standardized naming if not provided
* @returns The path where the report was saved
*/
/**
* Generate markdown report with comprehensive security validation
* @param data - Review report data containing all analysis results
* @param outputPath - Optional output path, will use standardized naming if not provided
* @returns The path where the report was saved
*/
generateMarkdownReport(data: ReviewReportData, outputPath?: string): Promise<string>;
/**
* Generate JSON report for programmatic consumption
* @param data - Review report data containing all analysis results
* @returns JSON string representation of the report
*/
/**
* Generate JSON report for programmatic consumption with security validation
* @param data - Review report data containing all analysis results
* @returns JSON string representation of the report
*/
generateJsonReport(data: ReviewReportData): string;
/**
* Validate report data for security and completeness
*/
private validateReportData;
/**
* Check if output path is secure
*/
private isSecureOutputPath;
/**
* Sanitize error messages for security
*/
private sanitizeError;
/**
* Update report generation metrics
*/
private updateMetrics;
/**
* Sanitize audit messages for security
*/
private sanitizeAuditMessage;
/**
* Get report generation metrics
*/
getReportMetrics(): {
reportsGenerated: number;
totalFindings: number;
securityIssuesFound: number;
averageGenerationTime: number;
};
/**
* Reset report generation metrics
*/
resetMetrics(): void;
/**
* Build markdown report with comprehensive security validation
*/
private buildMarkdownReport;
private groupQualityIssuesByFile;
private groupAuditsByPriority;
getReportSummary(data: ReviewReportData): string;
/**
* Add critical/high security findings section
*/
private addCriticalSecuritySection;
/**
* Add all security findings section
*/
private addAllSecuritySection;
private getToolEmoji;
private getSeverityEmoji;
/**
* Determine if code context should be shown for this result
*/
private shouldShowCodeContext;
/**
* Extract relevant code context from raw tool output
*/
private extractRelevantCodeContext;
/**
* Extract summary from SecurityScanResult array
*/
private getSecuritySummaryFromResults;
/**
* Flatten SecurityScanResult array to SecurityFinding array for JSON output
*/
private flattenSecurityResults;
/**
* Adds SOLID Architecture Analysis section to the report
*/
private addSOLIDAnalysisSection;
/**
* Groups SOLID violations by principle
*/
private groupSOLIDViolationsByPrinciple;
/**
* Generates specific SOLID recommendations based on violations
*/
private generateSOLIDRecommendations;
/**
* Add code smell analysis section to the report
*/
private addCodeSmellAnalysisSection;
/**
* Add list of code smell findings
*/
private addCodeSmellFindingsList;
/**
* Get icon for code smell type
*/
private getCodeSmellIcon;
/**
* Generate code smell recommendations
*/
private generateCodeSmellRecommendations;
/**
* Add AI Review section to the report
*/
private addAIReviewSection;
/**
* Add list of AI findings
*/
private addAIFindingsList;
/**
* Get icon for AI severity
*/
private getAISeverityIcon;
/**
* Get icon for AI category
*/
private getAICategoryIcon;
/**
* Generate AI review recommendations
*/
private generateAIReviewRecommendations;
}
//# sourceMappingURL=ReviewReportGenerator.d.ts.map