feature: add --dump diagnostic report flag to CLI (#65)

Wraps the logger and progress reporter with a DiagnosticCollector when --dump
is passed, and writes the markdown report after the run completes (success or
failure). --dump uses a default filename; --dump=<file> writes to a custom path.
The report path is printed to the console. E2E test asserts the report is
written with the expected sections.

Author: RandomCrocodile

Confuser.CLI/Program.cs

@@ -5,6 +5,7 @@
 using System.Linq;
 using System.Xml;
 using Confuser.Core;
+using Confuser.Core.Diagnostics;
 using Confuser.Core.Project;
 using Microsoft.Extensions.Logging;
 using NDesk.Options;
@@ -25,6 +26,8 @@ static int Main(string[] args) {
 				bool noPause = false;
 				bool debug = false;
 				bool quiet = false;
+				bool dumpRequested = false;
+				string dumpPath = null;
 				int verbosity = 0;
 				string outDir = null;
 				string snKeyPath = null;
@@ -59,6 +62,9 @@ static int Main(string[] args) {
 					}, {
 						"q|quiet", "only show warnings and errors.",
 						value => { quiet = (value != null); }
+					}, {
+						"dump:", "write a diagnostic report (optionally to the given file).",
+						value => { dumpRequested = true; if (!string.IsNullOrEmpty(value)) dumpPath = value; }
 					}
 				};
 
@@ -141,7 +147,7 @@ static int Main(string[] args) {
 					parameters.Project = proj;
 				}
 
-				int retVal = RunProject(parameters, quiet, verbosity);
+				int retVal = RunProject(parameters, quiet, verbosity, dumpRequested, dumpPath);
 
 				if (NeedPause() && !noPause) {
 					Console.WriteLine("Press any key to continue...");
@@ -203,7 +209,7 @@ static void LoadTemplateProject(string templatePath, ConfuserProject proj, List<
 					templateModules.Add(templateModule);
 		}
 
-		static int RunProject(ConfuserParameters parameters, bool quiet, int verbosity) {
+		static int RunProject(ConfuserParameters parameters, bool quiet, int verbosity, bool dumpRequested, string dumpPath) {
 			var levelSwitch = quiet
 				? LogEventLevel.Warning
 				: verbosity >= 3 ? LogEventLevel.Verbose
@@ -222,17 +228,44 @@ static int RunProject(ConfuserParameters parameters, bool quiet, int verbosity)
 			var melLogger = loggerFactory.CreateLogger("ConfuserEx");
 
 			var progressReporter = new ConsoleProgressReporter();
-			parameters.Logger = melLogger;
-			parameters.ProgressReporter = progressReporter;
+
+			// When a diagnostic report is requested, wrap both the logger and the progress reporter
+			// with a collector so the report captures the full transcript, timing and outcome even
+			// when the run fails.
+			DiagnosticCollector collector = null;
+			if (dumpRequested) {
+				collector = new DiagnosticCollector(melLogger, progressReporter) { Project = parameters.Project };
+				parameters.Logger = collector;
+				parameters.ProgressReporter = collector;
+			}
+			else {
+				parameters.Logger = melLogger;
+				parameters.ProgressReporter = progressReporter;
+			}
 
 			if (OperatingSystem.IsWindows())
 				Console.Title = "ConfuserEx - Running...";
 			ConfuserEngine.Run(parameters).GetAwaiter().GetResult();
 
 			Log.CloseAndFlush();
+
+			if (collector != null)
+				WriteDiagnosticReport(collector, dumpPath);
+
 			return progressReporter.ReturnValue;
 		}
 
+		static void WriteDiagnosticReport(DiagnosticCollector collector, string dumpPath) {
+			string path = string.IsNullOrEmpty(dumpPath) ? "confuser-diagnostic-report.md" : dumpPath;
+			try {
+				File.WriteAllText(path, collector.GenerateReport());
+				WriteLineWithColor(ConsoleColor.Cyan, "Diagnostic report written to: " + Path.GetFullPath(path));
+			}
+			catch (Exception ex) {
+				WriteLineWithColor(ConsoleColor.Red, "Failed to write diagnostic report: " + ex.Message);
+			}
+		}
+
 		static bool NeedPause() {
 			return Debugger.IsAttached || string.IsNullOrEmpty(Environment.GetEnvironmentVariable("PROMPT"));
 		}
@@ -250,6 +283,7 @@ static void PrintUsage() {
 			WriteLine("    -snkeypass : specifies strong name key password.");
 			WriteLine("    -v|verbose : increase verbosity (-v debug, -vv trace).");
 			WriteLine("    -q|quiet   : only show warnings and errors.");
+			WriteLine("    -dump      : write a diagnostic report (-dump=<file> for a custom path).");
 		}
 
 		static void WriteLineWithColor(ConsoleColor color, string txt) {

Tests/Confuser.CLI.Test/CliEndToEndTest.cs

@@ -70,6 +70,55 @@ public void Obfuscate_SampleApp_ProducesRunnableOutput() {
 			}
 		}
 
+		[Fact]
+		public void Cli_DumpFlag_WritesDiagnosticReport() {
+			var sampleAppExe = Path.Combine(AppContext.BaseDirectory, "Fixtures", "SampleApp", "bin", "SampleApp.exe");
+			Assert.True(File.Exists(sampleAppExe), $"Pre-built SampleApp.exe not found at {sampleAppExe}");
+
+			var cliDll = Path.Combine(AppContext.BaseDirectory, "Confuser.CLI.dll");
+			Assert.True(File.Exists(cliDll), $"Confuser.CLI.dll not found at {cliDll}");
+
+			var testDir = Path.Combine(Path.GetTempPath(), "confuserex-cli-dump-" + Guid.NewGuid().ToString("N")[..8]);
+			Directory.CreateDirectory(testDir);
+
+			try {
+				File.Copy(sampleAppExe, Path.Combine(testDir, "SampleApp.exe"));
+
+				var crproj = Path.Combine(testDir, "SampleApp.crproj");
+				File.WriteAllText(crproj,
+@"<project outputDir="".\obfuscated"" baseDir=""."" xmlns=""http://confuser.codeplex.com"">
+  <rule pattern=""true"" preset=""none"" inherit=""false"">
+    <protection id=""rename"" />
+  </rule>
+  <module path=""SampleApp.exe"" />
+</project>");
+
+				var reportPath = Path.Combine(testDir, "report.md");
+
+				// Act — run Confuser.CLI with the --dump flag pointing at an explicit path
+				var cliResult = RunProcess("dotnet", $"\"{cliDll}\" -n --dump=\"{reportPath}\" \"{crproj}\"");
+				output.WriteLine("=== Confuser.CLI Output ===");
+				output.WriteLine(cliResult.stdout);
+				if (!string.IsNullOrEmpty(cliResult.stderr))
+					output.WriteLine(cliResult.stderr);
+				Assert.Equal(0, cliResult.exitCode);
+
+				// Assert — the report was written and announced
+				Assert.True(File.Exists(reportPath), $"Diagnostic report should exist at {reportPath}");
+				Assert.Contains("Diagnostic report written to:", cliResult.stdout);
+
+				var report = File.ReadAllText(reportPath);
+				Assert.Contains("## System", report);
+				Assert.Contains("## Project Configuration", report);
+				Assert.Contains("## Result: SUCCESS", report);
+				Assert.Contains("## Log Output", report);
+				Assert.Contains("SampleApp.exe", report);
+			}
+			finally {
+				try { Directory.Delete(testDir, true); } catch { }
+			}
+		}
+
 		[Fact]
 		public void Cli_NoArgs_ReturnsNonZeroAndShowsUsage() {
 			var cliDll = Path.Combine(AppContext.BaseDirectory, "Confuser.CLI.dll");