Update the report location to be on method name and arguments instead of the InvocationExpression (#790)

meziantou · web-flow · commit f23df4e81c87 · 2025-03-19T13:24:58.000-04:00
diff --git a/global.json b/global.json
@@ -1,6 +1,6 @@
 {
   "sdk": {
-    "version": "9.0.101",
+    "version": "9.0.201",
     "rollForward": "latestPatch"
   }
 }
diff --git a/src/Meziantou.Analyzer/Internals/ContextExtensions.cs b/src/Meziantou.Analyzer/Internals/ContextExtensions.cs
@@ -1,9 +1,11 @@
-﻿using System.Collections.Immutable;
+using System;
+using System.Collections.Immutable;
 using System.Linq;
 using Meziantou.Analyzer.Internals;
 using Microsoft.CodeAnalysis;
 using Microsoft.CodeAnalysis.CSharp.Syntax;
 using Microsoft.CodeAnalysis.Operations;
+using Microsoft.CodeAnalysis.Text;
 
 namespace Meziantou.Analyzer.Internals;
 
@@ -156,14 +158,39 @@ public static void ReportDiagnostic(this DiagnosticReporter context, DiagnosticD
 
     public static void ReportDiagnostic(this DiagnosticReporter context, DiagnosticDescriptor descriptor, ImmutableDictionary<string, string?>? properties, IInvocationOperation operation, DiagnosticInvocationReportOptions options, params string?[]? messageArgs)
     {
+        TextSpan? span = null;
+
         if (options.HasFlag(DiagnosticInvocationReportOptions.ReportOnMember) &&
             operation.Syntax.ChildNodes().FirstOrDefault() is MemberAccessExpressionSyntax memberAccessExpression)
         {
-            context.ReportDiagnostic(Diagnostic.Create(descriptor, memberAccessExpression.Name.GetLocation(), properties, messageArgs));
+            SetSpan(memberAccessExpression.Name.Span);
+        }
+
+        if (options.HasFlag(DiagnosticInvocationReportOptions.ReportOnArguments) &&
+            operation.Syntax is InvocationExpressionSyntax invocationExpression)
+        {
+            SetSpan(invocationExpression.ArgumentList.Span);
+        }
+
+        if (span is not null)
+        {
+            context.ReportDiagnostic(Diagnostic.Create(descriptor, Location.Create(operation.Syntax.SyntaxTree, span.Value), properties, messageArgs));
             return;
         }
 
         context.ReportDiagnostic(descriptor, properties, operation, messageArgs);
+
+        void SetSpan(TextSpan newSpan)
+        {
+            if (span is null)
+            {
+                span = newSpan;
+            }
+            else
+            {
+                span = TextSpan.FromBounds(Math.Min(span.Value.Start, newSpan.Start), Math.Max(span.Value.End, newSpan.End));
+            }
+        }
     }
 
     public static void ReportDiagnostic(this DiagnosticReporter context, DiagnosticDescriptor descriptor, AttributeData attribute, params string?[]? messageArgs)
diff --git a/src/Meziantou.Analyzer/Internals/ContextExtensions.g.cs b/src/Meziantou.Analyzer/Internals/ContextExtensions.g.cs
@@ -63,6 +63,9 @@ public static void ReportDiagnostic(this SyntaxNodeAnalysisContext context, Diag
     public static void ReportDiagnostic(this SyntaxNodeAnalysisContext context, DiagnosticDescriptor descriptor, ImmutableDictionary<string, string?>? properties, SyntaxReference syntaxReference, params string?[]? messageArgs)
         => ReportDiagnostic(new DiagnosticReporter(context), descriptor, properties, syntaxReference, messageArgs);
         
+    public static void ReportDiagnostic(this SyntaxNodeAnalysisContext context, DiagnosticDescriptor descriptor, IInvocationOperation operation, DiagnosticInvocationReportOptions options, params string?[] messageArgs)
+        => ReportDiagnostic(new DiagnosticReporter(context), descriptor, properties: null, operation, options, messageArgs);
+        
     public static void ReportDiagnostic(this SyntaxNodeAnalysisContext context, DiagnosticDescriptor descriptor, ImmutableDictionary<string, string?>? properties, IInvocationOperation operation, DiagnosticInvocationReportOptions options, params string?[] messageArgs)
         => ReportDiagnostic(new DiagnosticReporter(context), descriptor, properties, operation, options, messageArgs);
 
@@ -134,6 +137,9 @@ public static void ReportDiagnostic(this SymbolAnalysisContext context, Diagnost
     public static void ReportDiagnostic(this SymbolAnalysisContext context, DiagnosticDescriptor descriptor, ImmutableDictionary<string, string?>? properties, SyntaxReference syntaxReference, params string?[]? messageArgs)
         => ReportDiagnostic(new DiagnosticReporter(context), descriptor, properties, syntaxReference, messageArgs);
         
+    public static void ReportDiagnostic(this SymbolAnalysisContext context, DiagnosticDescriptor descriptor, IInvocationOperation operation, DiagnosticInvocationReportOptions options, params string?[] messageArgs)
+        => ReportDiagnostic(new DiagnosticReporter(context), descriptor, properties: null, operation, options, messageArgs);
+        
     public static void ReportDiagnostic(this SymbolAnalysisContext context, DiagnosticDescriptor descriptor, ImmutableDictionary<string, string?>? properties, IInvocationOperation operation, DiagnosticInvocationReportOptions options, params string?[] messageArgs)
         => ReportDiagnostic(new DiagnosticReporter(context), descriptor, properties, operation, options, messageArgs);
 
@@ -205,6 +211,9 @@ public static void ReportDiagnostic(this OperationAnalysisContext context, Diagn
     public static void ReportDiagnostic(this OperationAnalysisContext context, DiagnosticDescriptor descriptor, ImmutableDictionary<string, string?>? properties, SyntaxReference syntaxReference, params string?[]? messageArgs)
         => ReportDiagnostic(new DiagnosticReporter(context), descriptor, properties, syntaxReference, messageArgs);
         
+    public static void ReportDiagnostic(this OperationAnalysisContext context, DiagnosticDescriptor descriptor, IInvocationOperation operation, DiagnosticInvocationReportOptions options, params string?[] messageArgs)
+        => ReportDiagnostic(new DiagnosticReporter(context), descriptor, properties: null, operation, options, messageArgs);
+        
     public static void ReportDiagnostic(this OperationAnalysisContext context, DiagnosticDescriptor descriptor, ImmutableDictionary<string, string?>? properties, IInvocationOperation operation, DiagnosticInvocationReportOptions options, params string?[] messageArgs)
         => ReportDiagnostic(new DiagnosticReporter(context), descriptor, properties, operation, options, messageArgs);
 
@@ -276,6 +285,9 @@ public static void ReportDiagnostic(this OperationBlockAnalysisContext context,
     public static void ReportDiagnostic(this OperationBlockAnalysisContext context, DiagnosticDescriptor descriptor, ImmutableDictionary<string, string?>? properties, SyntaxReference syntaxReference, params string?[]? messageArgs)
         => ReportDiagnostic(new DiagnosticReporter(context), descriptor, properties, syntaxReference, messageArgs);
         
+    public static void ReportDiagnostic(this OperationBlockAnalysisContext context, DiagnosticDescriptor descriptor, IInvocationOperation operation, DiagnosticInvocationReportOptions options, params string?[] messageArgs)
+        => ReportDiagnostic(new DiagnosticReporter(context), descriptor, properties: null, operation, options, messageArgs);
+        
     public static void ReportDiagnostic(this OperationBlockAnalysisContext context, DiagnosticDescriptor descriptor, ImmutableDictionary<string, string?>? properties, IInvocationOperation operation, DiagnosticInvocationReportOptions options, params string?[] messageArgs)
         => ReportDiagnostic(new DiagnosticReporter(context), descriptor, properties, operation, options, messageArgs);
 
@@ -347,6 +359,9 @@ public static void ReportDiagnostic(this CompilationAnalysisContext context, Dia
     public static void ReportDiagnostic(this CompilationAnalysisContext context, DiagnosticDescriptor descriptor, ImmutableDictionary<string, string?>? properties, SyntaxReference syntaxReference, params string?[]? messageArgs)
         => ReportDiagnostic(new DiagnosticReporter(context), descriptor, properties, syntaxReference, messageArgs);
         
+    public static void ReportDiagnostic(this CompilationAnalysisContext context, DiagnosticDescriptor descriptor, IInvocationOperation operation, DiagnosticInvocationReportOptions options, params string?[] messageArgs)
+        => ReportDiagnostic(new DiagnosticReporter(context), descriptor, properties: null, operation, options, messageArgs);
+        
     public static void ReportDiagnostic(this CompilationAnalysisContext context, DiagnosticDescriptor descriptor, ImmutableDictionary<string, string?>? properties, IInvocationOperation operation, DiagnosticInvocationReportOptions options, params string?[] messageArgs)
         => ReportDiagnostic(new DiagnosticReporter(context), descriptor, properties, operation, options, messageArgs);
 
diff --git a/src/Meziantou.Analyzer/Internals/ContextExtensions.tt b/src/Meziantou.Analyzer/Internals/ContextExtensions.tt
@@ -68,6 +68,9 @@ internal static partial class ContextExtensions
     public static void ReportDiagnostic(this <#= type #> context, DiagnosticDescriptor descriptor, ImmutableDictionary<string, string?>? properties, SyntaxReference syntaxReference, params string?[]? messageArgs)
         => ReportDiagnostic(new DiagnosticReporter(context), descriptor, properties, syntaxReference, messageArgs);
         
+    public static void ReportDiagnostic(this <#= type #> context, DiagnosticDescriptor descriptor, IInvocationOperation operation, DiagnosticInvocationReportOptions options, params string?[] messageArgs)
+        => ReportDiagnostic(new DiagnosticReporter(context), descriptor, properties: null, operation, options, messageArgs);
+        
     public static void ReportDiagnostic(this <#= type #> context, DiagnosticDescriptor descriptor, ImmutableDictionary<string, string?>? properties, IInvocationOperation operation, DiagnosticInvocationReportOptions options, params string?[] messageArgs)
         => ReportDiagnostic(new DiagnosticReporter(context), descriptor, properties, operation, options, messageArgs);
 
diff --git a/src/Meziantou.Analyzer/Internals/DiagnosticInvocationReportOptions.cs b/src/Meziantou.Analyzer/Internals/DiagnosticInvocationReportOptions.cs
@@ -1,4 +1,4 @@
-﻿using System;
+using System;
 
 namespace Meziantou.Analyzer.Internals;
 
@@ -7,4 +7,5 @@ public enum DiagnosticInvocationReportOptions
 {
     None = 0x0,
     ReportOnMember = 0x1,
+    ReportOnArguments = 0x2,
 }
diff --git a/src/Meziantou.Analyzer/Internals/ObjectPool.cs b/src/Meziantou.Analyzer/Internals/ObjectPool.cs
@@ -1,4 +1,4 @@
-﻿#pragma warning disable MA0048 // File name must match type name
+#pragma warning disable MA0048 // File name must match type name
 #pragma warning disable RS1035 // Do not use APIs banned for analyzers
 using System.Collections.Concurrent;
 using System.Threading;
@@ -56,14 +56,14 @@ internal interface IPooledObjectPolicy<T> where T : notnull
     /// Create a <typeparamref name="T"/>.
     /// </summary>
     /// <returns>The <typeparamref name="T"/> which was created.</returns>
-    T Create();
+    public T Create();
 
     /// <summary>
     /// Runs some processing when an object was returned to the pool. Can be used to reset the state of an object and indicate if the object should be returned to the pool.
     /// </summary>
     /// <param name="obj">The object to return to the pool.</param>
     /// <returns><see langword="true" /> if the object should be returned to the pool. <see langword="false" /> if it's not possible/desirable for the pool to keep the object.</returns>
-    bool Return(T obj);
+    public bool Return(T obj);
 }
 
 /// <summary>
@@ -249,7 +249,7 @@ internal interface IResettable
     /// <remarks>
     /// In general, this method is not expected to be thread-safe.
     /// </remarks>
-    bool TryReset();
+    public bool TryReset();
 }
 
 internal sealed class DisposableObjectPool<T> : DefaultObjectPool<T>, IDisposable where T : class
diff --git a/src/Meziantou.Analyzer/Rules/UseStringComparerAnalyzer.cs b/src/Meziantou.Analyzer/Rules/UseStringComparerAnalyzer.cs
@@ -14,6 +14,8 @@ namespace Meziantou.Analyzer.Rules;
 [DiagnosticAnalyzer(LanguageNames.CSharp)]
 public sealed class UseStringComparerAnalyzer : DiagnosticAnalyzer
 {
+    private const DiagnosticInvocationReportOptions DefaultDiagnosticInvocationReportOptions = DiagnosticInvocationReportOptions.ReportOnMember | DiagnosticInvocationReportOptions.ReportOnArguments;
+
     private static readonly string[] EnumerableMethods =
     [
         "Contains",
@@ -130,7 +132,7 @@ public void AnalyzeInvocation(OperationAnalysisContext ctx)
             if ((EqualityComparerStringType is not null && _overloadFinder.HasOverloadWithAdditionalParameterOfType(method, operation, EqualityComparerStringType)) ||
                 (ComparerStringType is not null && _overloadFinder.HasOverloadWithAdditionalParameterOfType(method, operation, ComparerStringType)))
             {
-                ctx.ReportDiagnostic(Rule, operation);
+                ctx.ReportDiagnostic(Rule, operation, DefaultDiagnosticInvocationReportOptions);
                 return;
             }
 
@@ -164,7 +166,7 @@ public void AnalyzeInvocation(OperationAnalysisContext ctx)
 
                 if (!HasEqualityComparerArgument(operation.Arguments))
                 {
-                    ctx.ReportDiagnostic(Rule, operation);
+                    ctx.ReportDiagnostic(Rule, operation, DefaultDiagnosticInvocationReportOptions);
                 }
             }
         }
diff --git a/tests/Meziantou.Analyzer.Test/Rules/UseStringComparerAnalyzerTests.cs b/tests/Meziantou.Analyzer.Test/Rules/UseStringComparerAnalyzerTests.cs
@@ -183,7 +183,7 @@ class TypeName
     public void Test()
     {
         System.Collections.Generic.IEnumerable<string> obj = null;
-        [||]obj.Contains("""");
+        obj.[|Contains("""")|];
     }
 }";
         const string CodeFix = @"using System.Linq;
@@ -210,7 +210,7 @@ class TypeName
     public void Test()
     {
         System.Collections.Generic.IEnumerable<string> obj = null;
-        [||]obj.ToDictionary(p => p);
+        obj.[|ToDictionary(p => p)|];
     }
 }";
         const string CodeFix = @"using System.Linq;
@@ -237,7 +237,7 @@ class TypeName
     public void Test()
     {
         System.Collections.Generic.IEnumerable<string> obj = null;
-        [||]obj.Order();
+        obj.[|Order()|];
     }
 }";
         const string CodeFix = @"using System.Linq;
@@ -265,7 +265,7 @@ class TypeName
     public void Test()
     {
         System.Collections.Generic.IEnumerable<string> obj = null;
-        [||]obj.OrderBy(p => p);
+        obj.[|OrderBy(p => p)|];
     }
 }";
         const string CodeFix = @"using System.Linq;
@@ -292,7 +292,7 @@ class TypeName
     public void Test()
     {
         System.Collections.Generic.IEnumerable<string> obj = null;
-        [||]obj.OrderByDescending(p => p);
+        obj.[|OrderByDescending(p => p)|];
     }
 }";
         const string CodeFix = @"using System.Linq;
@@ -319,7 +319,7 @@ class TypeName
     public void Test()
     {
         System.Collections.Generic.IEnumerable<string> obj = null;
-        [||]obj.OrderBy(p => p, System.StringComparer.Ordinal).ThenBy(p => p);
+        obj.OrderBy(p => p, System.StringComparer.Ordinal).[|ThenBy(p => p)|];
     }
 }";
         const string CodeFix = @"using System.Linq;
@@ -346,7 +346,7 @@ class TypeName
     public void Test()
     {
         System.Collections.Generic.IEnumerable<string> obj = null;
-        [||]obj.OrderBy(p => p, System.StringComparer.Ordinal).ThenByDescending(p => p);
+        obj.OrderBy(p => p, System.StringComparer.Ordinal).[|ThenByDescending(p => p)|];
     }
 }";
         const string CodeFix = @"using System.Linq;
@@ -387,7 +387,7 @@ class Usage
     void A()
     {
         var a = new TypeName();
-        [||]a.Test();
+        a.[|Test()|];
     }
 }
 ";

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"sdk": {`
`3`		`- "version": "9.0.101",`
	`3`	`+ "version": "9.0.201",`
`4`	`4`	`"rollForward": "latestPatch"`
`5`	`5`	`}`
`6`	`6`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-using System;`
	`1`	`+using System;`
`2`	`2`
`3`	`3`	`namespace Meziantou.Analyzer.Internals;`
`4`	`4`
`@@ -7,4 +7,5 @@ public enum DiagnosticInvocationReportOptions`
`7`	`7`	`{`
`8`	`8`	`None = 0x0,`
`9`	`9`	`ReportOnMember = 0x1,`
	`10`	`+ ReportOnArguments = 0x2,`
`10`	`11`	`}`
Original file line number	Diff line number	Diff line change
`@@ -14,6 +14,8 @@ namespace Meziantou.Analyzer.Rules;`
`14`	`14`	`[DiagnosticAnalyzer(LanguageNames.CSharp)]`
`15`	`15`	`public sealed class UseStringComparerAnalyzer : DiagnosticAnalyzer`
`16`	`16`	`{`
	`17`	`+ private const DiagnosticInvocationReportOptions DefaultDiagnosticInvocationReportOptions = DiagnosticInvocationReportOptions.ReportOnMember \| DiagnosticInvocationReportOptions.ReportOnArguments;`
	`18`	`+`
`17`	`19`	`private static readonly string[] EnumerableMethods =`
`18`	`20`	`[`
`19`	`21`	`"Contains",`
`@@ -130,7 +132,7 @@ public void AnalyzeInvocation(OperationAnalysisContext ctx)`
`130`	`132`	`if ((EqualityComparerStringType is not null && _overloadFinder.HasOverloadWithAdditionalParameterOfType(method, operation, EqualityComparerStringType)) \|\|`
`131`	`133`	`(ComparerStringType is not null && _overloadFinder.HasOverloadWithAdditionalParameterOfType(method, operation, ComparerStringType)))`
`132`	`134`	`{`
`133`		`- ctx.ReportDiagnostic(Rule, operation);`
	`135`	`+ ctx.ReportDiagnostic(Rule, operation, DefaultDiagnosticInvocationReportOptions);`
`134`	`136`	`return;`
`135`	`137`	`}`
`136`	`138`
`@@ -164,7 +166,7 @@ public void AnalyzeInvocation(OperationAnalysisContext ctx)`
`164`	`166`
`165`	`167`	`if (!HasEqualityComparerArgument(operation.Arguments))`
`166`	`168`	`{`
`167`		`- ctx.ReportDiagnostic(Rule, operation);`
	`169`	`+ ctx.ReportDiagnostic(Rule, operation, DefaultDiagnosticInvocationReportOptions);`
`168`	`170`	`}`
`169`	`171`	`}`
`170`	`172`	`}`
Original file line number	Diff line number	Diff line change
`@@ -183,7 +183,7 @@ class TypeName`
`183`	`183`	`public void Test()`
`184`	`184`	`{`
`185`	`185`	`System.Collections.Generic.IEnumerable<string> obj = null;`
`186`		`- [\|\|]obj.Contains("""");`
	`186`	`+ obj.[\|Contains("""")\|];`
`187`	`187`	`}`
`188`	`188`	`}";`
`189`	`189`	`const string CodeFix = @"using System.Linq;`
`@@ -210,7 +210,7 @@ class TypeName`
`210`	`210`	`public void Test()`
`211`	`211`	`{`
`212`	`212`	`System.Collections.Generic.IEnumerable<string> obj = null;`
`213`		`- [\|\|]obj.ToDictionary(p => p);`
	`213`	`+ obj.[\|ToDictionary(p => p)\|];`
`214`	`214`	`}`
`215`	`215`	`}";`
`216`	`216`	`const string CodeFix = @"using System.Linq;`
`@@ -237,7 +237,7 @@ class TypeName`
`237`	`237`	`public void Test()`
`238`	`238`	`{`
`239`	`239`	`System.Collections.Generic.IEnumerable<string> obj = null;`
`240`		`- [\|\|]obj.Order();`
	`240`	`+ obj.[\|Order()\|];`
`241`	`241`	`}`
`242`	`242`	`}";`
`243`	`243`	`const string CodeFix = @"using System.Linq;`
`@@ -265,7 +265,7 @@ class TypeName`
`265`	`265`	`public void Test()`
`266`	`266`	`{`
`267`	`267`	`System.Collections.Generic.IEnumerable<string> obj = null;`
`268`		`- [\|\|]obj.OrderBy(p => p);`
	`268`	`+ obj.[\|OrderBy(p => p)\|];`
`269`	`269`	`}`
`270`	`270`	`}";`
`271`	`271`	`const string CodeFix = @"using System.Linq;`
`@@ -292,7 +292,7 @@ class TypeName`
`292`	`292`	`public void Test()`
`293`	`293`	`{`
`294`	`294`	`System.Collections.Generic.IEnumerable<string> obj = null;`
`295`		`- [\|\|]obj.OrderByDescending(p => p);`
	`295`	`+ obj.[\|OrderByDescending(p => p)\|];`
`296`	`296`	`}`
`297`	`297`	`}";`
`298`	`298`	`const string CodeFix = @"using System.Linq;`
`@@ -319,7 +319,7 @@ class TypeName`
`319`	`319`	`public void Test()`
`320`	`320`	`{`
`321`	`321`	`System.Collections.Generic.IEnumerable<string> obj = null;`
`322`		`- [\|\|]obj.OrderBy(p => p, System.StringComparer.Ordinal).ThenBy(p => p);`
	`322`	`+ obj.OrderBy(p => p, System.StringComparer.Ordinal).[\|ThenBy(p => p)\|];`
`323`	`323`	`}`
`324`	`324`	`}";`
`325`	`325`	`const string CodeFix = @"using System.Linq;`
`@@ -346,7 +346,7 @@ class TypeName`
`346`	`346`	`public void Test()`
`347`	`347`	`{`
`348`	`348`	`System.Collections.Generic.IEnumerable<string> obj = null;`
`349`		`- [\|\|]obj.OrderBy(p => p, System.StringComparer.Ordinal).ThenByDescending(p => p);`
	`349`	`+ obj.OrderBy(p => p, System.StringComparer.Ordinal).[\|ThenByDescending(p => p)\|];`
`350`	`350`	`}`
`351`	`351`	`}";`
`352`	`352`	`const string CodeFix = @"using System.Linq;`
`@@ -387,7 +387,7 @@ class Usage`
`387`	`387`	`void A()`
`388`	`388`	`{`
`389`	`389`	`var a = new TypeName();`
`390`		`- [\|\|]a.Test();`
	`390`	`+ a.[\|Test()\|];`
`391`	`391`	`}`
`392`	`392`	`}`
`393`	`393`	`";`