SOMS/SolutionCleanupTool/Interfaces/IReportGenerator.cs
2025-12-31 14:25:09 +08:00

33 lines
1.4 KiB
C#

using SolutionCleanupTool.Models;
namespace SolutionCleanupTool.Interfaces
{
/// <summary>
/// Interface for generating cleanup reports
/// </summary>
public interface IReportGenerator
{
/// <summary>
/// Generates a detailed cleanup report
/// </summary>
/// <param name="cleanupResult">The result of the cleanup operation</param>
/// <param name="validationResult">The result of post-cleanup validation</param>
/// <param name="solutionPath">Path to the original solution file</param>
/// <returns>Formatted report as a string</returns>
string GenerateReport(CleanupResult cleanupResult, ValidationResult validationResult, string solutionPath);
/// <summary>
/// Generates a summary report with key statistics
/// </summary>
/// <param name="cleanupResult">The result of the cleanup operation</param>
/// <returns>Summary report as a string</returns>
string GenerateSummary(CleanupResult cleanupResult);
/// <summary>
/// Generates restoration recommendations for removed projects
/// </summary>
/// <param name="removedProjects">List of projects that were removed</param>
/// <returns>Restoration recommendations as a string</returns>
string GenerateRestorationRecommendations(List<MissingProject> removedProjects);
}
}