fix: Report PH2071 diagnostics inline for IDE support (#1084)

Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>

Author: ajbarga

Philips.CodeAnalysis.DuplicateCodeAnalyzer/AvoidDuplicateCodeAnalyzer.cs

@@ -107,7 +107,7 @@ public virtual EditorConfigOptions InitializeEditorConfigOptions(out Diagnostic
 		private sealed class CompilationAnalyzer
 		{
 			private readonly DuplicateDetector _library = new();
-			private readonly List<Diagnostic> _diagnostics = [];
+			private readonly Diagnostic _configurationError;
 			private readonly int _duplicateTokenThreshold;
 			private readonly Helper _helper;
 			private readonly bool _shouldGenerateExceptionsFile;
@@ -118,10 +118,7 @@ public CompilationAnalyzer(int duplicateTokenThreshold, Helper helper, bool shou
 				_duplicateTokenThreshold = duplicateTokenThreshold;
 				_helper = helper;
 				_shouldGenerateExceptionsFile = shouldGenerateExceptionsFile;
-				if (configurationError != null)
-				{
-					_diagnostics.Add(configurationError);
-				}
+				_configurationError = configurationError;
 			}
 
 			private string ToPrettyReference(FileLinePositionSpan fileSpan)
@@ -163,7 +160,7 @@ public void AnalyzeMethod(SyntaxNodeAnalysisContext obj)
 							{
 								Location location = evidence.LocationEnvelope.Contents();
 								Location existingEvidenceLocation = existingEvidence.LocationEnvelope.Contents();
-								CreateDuplicateDiagnostic(location, existingEvidenceLocation, token, methodDeclarationSyntax);
+								ReportDuplicateDiagnostic(obj, location, existingEvidenceLocation, token, methodDeclarationSyntax);
 
 								// Don't pile on.  Move on to the next method.
 								return;
@@ -177,7 +174,7 @@ public void AnalyzeMethod(SyntaxNodeAnalysisContext obj)
 				}
 			}
 
-			private void CreateDuplicateDiagnostic(Location location, Location existingEvidenceLocation, SyntaxToken token, MethodDeclarationSyntax methodDeclarationSyntax)
+			private void ReportDuplicateDiagnostic(SyntaxNodeAnalysisContext context, Location location, Location existingEvidenceLocation, SyntaxToken token, MethodDeclarationSyntax methodDeclarationSyntax)
 			{
 				// We found a duplicate, but if it's partially duplicated with itself, ignore it.
 				if (!location.SourceSpan.IntersectsWith(existingEvidenceLocation.SourceSpan))
@@ -186,7 +183,7 @@ private void CreateDuplicateDiagnostic(Location location, Location existingEvide
 					FileLinePositionSpan existingEvidenceLineSpan = existingEvidenceLocation.GetLineSpan();
 					var reference = ToPrettyReference(existingEvidenceLineSpan);
 
-					_diagnostics.Add(Diagnostic.Create(Rule, location, new List<Location>() { existingEvidenceLocation }, reference, shapeDetails));
+					context.ReportDiagnostic(Diagnostic.Create(Rule, location, new List<Location>() { existingEvidenceLocation }, reference, shapeDetails));
 
 					if (_shouldGenerateExceptionsFile)
 					{
@@ -216,14 +213,14 @@ private void CreateExceptionDiagnostic(Exception ex, SyntaxNodeAnalysisContext s
 				}
 
 				Location location = syntaxNodeAnalysisContext.Node.GetLocation();
-				_diagnostics.Add(Diagnostic.Create(UnhandledExceptionRule, location, result, ex.Message));
+				syntaxNodeAnalysisContext.ReportDiagnostic(Diagnostic.Create(UnhandledExceptionRule, location, result, ex.Message));
 			}
 
 			public void EndCompilationAction(CompilationAnalysisContext context)
 			{
-				foreach (Diagnostic diagnostic in _diagnostics)
+				if (_configurationError != null)
 				{
-					context.ReportDiagnostic(diagnostic);
+					context.ReportDiagnostic(_configurationError);
 				}
 			}
 

Philips.CodeAnalysis.Test/DuplicateCode/AvoidDuplicateCodeAnalyzerTest.cs

@@ -1,6 +1,7 @@
 // © 2019 Koninklijke Philips N.V. See License.md in the project root for license information.
 
 using System.Collections.Immutable;
+using System.IO;
 using System.Linq;
 using System.Text.RegularExpressions;
 using System.Threading.Tasks;
@@ -392,4 +393,115 @@ await VerifyDiagnostic(file,
 			).ConfigureAwait(false);
 		}
 	}
+
+	[TestClass]
+	public class AvoidDuplicateCodeInvalidTokenCountTest : DiagnosticVerifier
+	{
+		protected override DiagnosticAnalyzer GetDiagnosticAnalyzer()
+		{
+			return new AvoidDuplicateCodeAnalyzer() { DefaultDuplicateTokenThreshold = 100 };
+		}
+
+		protected override ImmutableDictionary<string, string> GetAdditionalAnalyzerConfigOptions()
+		{
+			return base.GetAdditionalAnalyzerConfigOptions()
+				.Add($@"dotnet_code_quality.{AvoidDuplicateCodeAnalyzer.Rule.Id}.token_count", @"abc");
+		}
+
+		[TestMethod]
+		[TestCategory(TestDefinitions.UnitTests)]
+		public async Task AvoidDuplicateCodeReportsInvalidTokenCountAsync()
+		{
+			var source = @"
+namespace MyNamespace
+{{
+  class FooClass
+  {{
+    public void Foo()
+    {{
+	  object obj = new object();
+    }}
+  }}
+}}
+";
+
+			await VerifyDiagnostic(source,
+				new DiagnosticResult()
+				{
+					Id = AvoidDuplicateCodeAnalyzer.Rule.Id,
+					Message = new Regex(".+invalid.+"),
+					Severity = DiagnosticSeverity.Error,
+					Locations = [],
+				}
+			).ConfigureAwait(false);
+		}
+	}
+
+	[TestClass]
+	public class AvoidDuplicateCodeGenerateExceptionsFileTest : AvoidDuplicateCodeAnalyzerTest
+	{
+		private const string GeneratedFileName = @"DuplicateCode.Allowed.GENERATED.txt";
+
+		protected override ImmutableDictionary<string, string> GetAdditionalAnalyzerConfigOptions()
+		{
+			return base.GetAdditionalAnalyzerConfigOptions()
+				.Add($@"dotnet_code_quality.{AvoidDuplicateCodeAnalyzer.Rule.Id}.generate_exceptions_file", @"true");
+		}
+
+		[TestMethod]
+		[TestCategory(TestDefinitions.UnitTests)]
+		public async Task AvoidDuplicateCodeGeneratesExceptionsFileAsync()
+		{
+			// Ensure clean state
+			if (File.Exists(GeneratedFileName))
+			{
+				File.Delete(GeneratedFileName);
+			}
+
+			var source = @"
+namespace MyNamespace
+{{
+  class FooClass
+  {{
+    public void Foo()
+    {{
+	  object obj = new object(); object obj2 = new object(); object obj3 = new object();
+    }}
+    public void Bar()
+    {{
+	  object obj = new object(); object obj2 = new object(); object obj3 = new object();
+    }}
+  }}
+}}
+";
+
+			try
+			{
+				await VerifyDiagnostic(source,
+					new DiagnosticResult()
+					{
+						Id = AvoidDuplicateCodeAnalyzer.Rule.Id,
+						Message = new Regex("Duplicate shape found.+"),
+						Severity = DiagnosticSeverity.Error,
+						Locations = new[]
+						{
+							new DiagnosticResultLocation("Test0.cs", null, null),
+							new DiagnosticResultLocation("Test0.cs", null, null),
+						}
+					}
+				).ConfigureAwait(false);
+
+				Assert.IsTrue(File.Exists(GeneratedFileName), $"Expected {GeneratedFileName} to be generated when generate_exceptions_file is enabled.");
+				var content = File.ReadAllText(GeneratedFileName);
+				Assert.Contains("Bar", content);
+			}
+			finally
+			{
+				if (File.Exists(GeneratedFileName))
+				{
+					File.Delete(GeneratedFileName);
+				}
+			}
+		}
+	}
 }