Skip to content

Fix configuration precedence for OutputFormat and OutputPath (#38) #43

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jbrinkman merged 4 commits into from
Jul 31, 2025
Merged

Fix configuration precedence for OutputFormat and OutputPath (#38) #43

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
e2110be
Fix configuration precedence for OutputFormat and OutputPath
jbrinkman Jul 31, 2025
0196d63
chore: resolve stylecop issue
jbrinkman Jul 31, 2025
ce602cd
Fix Windows CI: Escape backslashes in JSON path interpolation
jbrinkman Jul 31, 2025
0c0cd2b
Fix additional Windows CI issue: Escape file paths in JSON replacement
jbrinkman Jul 31, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
68 changes: 32 additions & 36 deletions src/DotNetApiDiff/Commands/CompareCommand.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,7 @@ public class CompareCommandSettings : CommandSettings

[CommandOption("-o|--output <format>")]
[Description("Output format (console, json, html, markdown)")]
[DefaultValue("console")]
public string OutputFormat { get; set; } = "console";
public string? OutputFormat { get; set; }

[CommandOption("-p|--output-file <path>")]
[Description("Output file path (required for json, html, markdown formats)")]
Expand Down Expand Up @@ -137,27 +136,30 @@ public override ValidationResult Validate([NotNull] CommandContext context, [Not
return ValidationResult.Error($"Configuration file not found: {settings.ConfigFile}");
}

// Validate output format
string format = settings.OutputFormat.ToLowerInvariant();
if (format != "console" && format != "json" && format != "html" && format != "markdown")
// Validate output format if provided
if (!string.IsNullOrEmpty(settings.OutputFormat))
{
return ValidationResult.Error($"Invalid output format: {settings.OutputFormat}. Valid formats are: console, json, html, markdown");
}

// Validate output file requirements
if (format == "html")
{
// HTML format requires an output file
if (string.IsNullOrEmpty(settings.OutputFile))
string format = settings.OutputFormat.ToLowerInvariant();
if (format != "console" && format != "json" && format != "html" && format != "markdown")
{
return ValidationResult.Error($"Output file is required for {settings.OutputFormat} format. Use --output-file to specify the output file path.");
return ValidationResult.Error($"Invalid output format: {settings.OutputFormat}. Valid formats are: console, json, html, markdown");
}

// Validate output directory exists
var outputDir = Path.GetDirectoryName(settings.OutputFile);
if (!string.IsNullOrEmpty(outputDir) && !Directory.Exists(outputDir))
// Validate output file requirements
if (format == "html")
{
return ValidationResult.Error($"Output directory does not exist: {outputDir}");
// HTML format requires an output file
if (string.IsNullOrEmpty(settings.OutputFile))
{
return ValidationResult.Error($"Output file is required for {settings.OutputFormat} format. Use --output-file to specify the output file path.");
}

// Validate output directory exists
var outputDir = Path.GetDirectoryName(settings.OutputFile);
if (!string.IsNullOrEmpty(outputDir) && !Directory.Exists(outputDir))
{
return ValidationResult.Error($"Output directory does not exist: {outputDir}");
}
}
}
else if (!string.IsNullOrEmpty(settings.OutputFile))
Expand Down Expand Up @@ -369,8 +371,8 @@ private int ExecuteWithConfiguredServices(CompareCommandSettings settings, Compa
// Use the single CompareAssemblies method - configuration is now injected into dependencies
comparisonResult = apiComparer.CompareAssemblies(sourceAssembly, targetAssembly);

// Update configuration with actual command-line values used for this comparison
if (Enum.TryParse<ReportFormat>(settings.OutputFormat, true, out var outputFormat))
// Update configuration with actual command-line values ONLY if explicitly provided by user
if (!string.IsNullOrEmpty(settings.OutputFormat) && Enum.TryParse<ReportFormat>(settings.OutputFormat, true, out var outputFormat))
{
comparisonResult.Configuration.OutputFormat = outputFormat;
}
Expand All @@ -395,26 +397,20 @@ private int ExecuteWithConfiguredServices(CompareCommandSettings settings, Compa
// Generate report
using (_logger.BeginScope("Report generation"))
{
_logger.LogInformation("Generating {Format} report", settings.OutputFormat);
var reportGenerator = serviceProvider.GetRequiredService<IReportGenerator>();
// Use the configuration from the comparison result, which now has the correct precedence applied
var effectiveFormat = comparisonResult.Configuration.OutputFormat;
var effectiveOutputFile = comparisonResult.Configuration.OutputPath;

// Convert string format to ReportFormat enum
ReportFormat format = settings.OutputFormat.ToLowerInvariant() switch
{
"json" => ReportFormat.Json,
"xml" => ReportFormat.Xml,
"html" => ReportFormat.Html,
"markdown" => ReportFormat.Markdown,
_ => ReportFormat.Console
};
_logger.LogInformation("Generating {Format} report", effectiveFormat);
var reportGenerator = serviceProvider.GetRequiredService<IReportGenerator>();

string report;
try
{
if (string.IsNullOrEmpty(settings.OutputFile))
if (string.IsNullOrEmpty(effectiveOutputFile))
{
// No output file specified - output to console regardless of format
report = reportGenerator.GenerateReport(comparisonResult, format);
report = reportGenerator.GenerateReport(comparisonResult, effectiveFormat);

// Output the formatted report to the console
// Use Console.Write to avoid format string interpretation issues
Expand All @@ -423,13 +419,13 @@ private int ExecuteWithConfiguredServices(CompareCommandSettings settings, Compa
else
{
// Output file specified - save to the specified file
reportGenerator.SaveReportAsync(comparisonResult, format, settings.OutputFile).GetAwaiter().GetResult();
_logger.LogInformation("Report saved to {OutputFile}", settings.OutputFile);
reportGenerator.SaveReportAsync(comparisonResult, effectiveFormat, effectiveOutputFile).GetAwaiter().GetResult();
_logger.LogInformation("Report saved to {OutputFile}", effectiveOutputFile);
}
}
catch (Exception ex)
{
_logger.LogError(ex, "Error generating {Format} report", format);
_logger.LogError(ex, "Error generating {Format} report", effectiveFormat);
AnsiConsole.MarkupLine($"[red]Error generating report:[/] {ex.Message}");

return _exitCodeManager.GetExitCodeForException(ex);
Expand Down
5 changes: 3 additions & 2 deletions src/DotNetApiDiff/Models/Configuration/ComparisonConfiguration.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ public static ComparisonConfiguration LoadFromJsonFile(string path)
PropertyNameCaseInsensitive = true,
ReadCommentHandling = JsonCommentHandling.Skip,
AllowTrailingCommas = true,
Converters = { new JsonStringEnumConverter() }
Converters = { new JsonStringEnumConverter(null, false) }
};

var config = JsonSerializer.Deserialize<ComparisonConfiguration>(json, options);
Expand Down Expand Up @@ -129,7 +129,8 @@ public void SaveToJsonFile(string path)
var options = new JsonSerializerOptions
{
WriteIndented = true,
PropertyNamingPolicy = JsonNamingPolicy.CamelCase
PropertyNamingPolicy = JsonNamingPolicy.CamelCase,
Converters = { new JsonStringEnumConverter(null, false) }
};

var json = JsonSerializer.Serialize(this, options);
Expand Down
Loading
Loading