Skip private types for MEN019 by default

Author: menees

src/Directory.Build.props

@@ -21,7 +21,7 @@
 		<AssemblyOriginatorKeyFile>../Analyzers.snk</AssemblyOriginatorKeyFile>
 
 		<!-- NOTE: Change the version in Vsix\source.extension.vsixmanifest to match this! -->
-		<Version>3.3.3</Version>
+		<Version>3.3.4</Version>
 
 		<RoslynVersion>3.11.0</RoslynVersion>
 	</PropertyGroup>

src/Menees.Analyzers.Vsix/source.extension.vsixmanifest

@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="utf-8"?>
 <PackageManifest Version="2.0.0" xmlns="http://schemas.microsoft.com/developer/vsx-schema/2011" xmlns:d="http://schemas.microsoft.com/developer/vsx-schema-design/2011">
     <Metadata>
-        <Identity Id="Menees.Analyzers.Vsix" Version="3.3.3" Language="en-US" Publisher="Bill Menees"/>
+        <Identity Id="Menees.Analyzers.Vsix" Version="3.3.4" Language="en-US" Publisher="Bill Menees"/>
         <DisplayName>Menees.Analyzers.Vsix</DisplayName>
         <Description xml:space="preserve">Provides analyzers for validating that tabs are used for indentation, that the lengths of lines, methods, properties, and files are acceptable, and that #regions are used within long files and files that contain multiple types.</Description>
         <License>License.txt</License>

src/Menees.Analyzers/Men019SupportAsyncCancellationToken.cs

@@ -102,21 +102,22 @@ public void HandleNamedTypeSymbol(SymbolAnalysisContext context)
 
 			// If the namedType has an instance-level CancellationToken property, then instance methods don't need a parameter.
 			bool checkInstanceMethods = !CanAccessCancellationTokenProperty(source: namedType, target: namedType);
+			Settings settings = this.callingAnalyzer.Settings;
 
 			// Look at each overload method group (including inherited methods).
 			// If a method group has any eligible async/awaitable methods and none
 			// of those are cancellable, then we'll report the "most eligible" method.
 #pragma warning disable IDE0079 // Remove unnecessary suppression. False positive!
 #pragma warning disable RS1024 // Compare symbols correctly. False positive! We're grouping by the Name not IMethodSymbol.
 			IEnumerable<IGrouping<string, IMethodSymbol>> methodGroups = GetTypeAndBaseTypes(namedType)
+				.Where(type => type.DeclaredAccessibility > Accessibility.Private || settings.CheckPrivateTypesForCancellation)
 				.SelectMany(type => type.GetMembers())
 				.OfType<IMethodSymbol>()
 				.Where(method => checkInstanceMethods || method.IsStatic)
 				.GroupBy(m => m.Name, m => m, StringComparer.Ordinal);
 #pragma warning restore RS1024 // Compare symbols correctly
 #pragma warning restore IDE0079 // Remove unnecessary suppression
 
-			Settings settings = this.callingAnalyzer.Settings;
 			foreach (IGrouping<string, IMethodSymbol> methodGroup in methodGroups)
 			{
 				List<IMethodSymbol> eligibleMethods = [];
@@ -302,7 +303,7 @@ private bool CanAccessCancellationTokenProperty(ITypeSymbol source, ITypeSymbol
 							// per-operation intent. https://devblogs.microsoft.com/dotnet/net-4-cancellation-framework/
 							&& !m.IsStatic
 							// If m is an inherited property, we have to use its containing type not target.
-							&& m.DeclaredAccessibility >= GetMinimumAccessibility(tuple.Source, m.ContainingType))
+							&& m.DeclaredAccessibility >= GetMinimumAccessibilityToUseTargetMember(tuple.Source, m.ContainingType))
 						.Cast<IPropertySymbol>();
 					foreach (IPropertySymbol propertySymbol in publicCancellationProperties)
 					{
@@ -319,7 +320,7 @@ private bool CanAccessCancellationTokenProperty(ITypeSymbol source, ITypeSymbol
 			return result;
 		}
 
-		private Accessibility GetMinimumAccessibility(ITypeSymbol source, ITypeSymbol target)
+		private Accessibility GetMinimumAccessibilityToUseTargetMember(ITypeSymbol source, ITypeSymbol target)
 		{
 			Accessibility result = Accessibility.Public;
 

src/Menees.Analyzers/Menees.Analyzers.Settings.xsd

@@ -110,6 +110,7 @@
 							</xs:element>
 						</xs:sequence>
 						<xs:attribute name="CheckPrivateMethods" type="xs:boolean" default="false"/>
+						<xs:attribute name="CheckPrivateTypes" type="xs:boolean" default="false"/>
 					</xs:complexType>
 				</xs:element>
 			</xs:all>

src/Menees.Analyzers/Settings.cs

@@ -145,6 +145,11 @@ private Settings(XElement xml)
 				this.CheckPrivateMethodsForCancellation = value;
 			}
 
+			if (TryParseXsBoolean(supportAsyncCancellationToken.Attribute("CheckPrivateTypes")?.Value, out value))
+			{
+				this.CheckPrivateTypesForCancellation = value;
+			}
+
 			XElement? properties = supportAsyncCancellationToken.Element("Properties");
 			if (properties != null)
 			{
@@ -196,6 +201,8 @@ private Settings(XElement xml)
 
 	public bool CheckPrivateMethodsForCancellation { get; }
 
+	public bool CheckPrivateTypesForCancellation { get; }
+
 	public HashSet<string> PropertyNamesForCancellation { get; } = new HashSet<string>([nameof(CancellationToken), "Cancellation"]);
 
 	#endregion

tests/Menees.Analyzers.Test/Men019UnitTests.cs

@@ -61,6 +61,11 @@ public class Test
 			public Awaitable TryAwaitable() { return new Awaitable(); }
 
 			public MyTask UseMyTask() => new();
+
+			private class Nested
+			{
+				public Task NestedMethodAsync(string? text) => Task.CompletedTask;
+			}
 		}
 		""" + SharedCode;
 
@@ -208,6 +213,11 @@ public void InvalidCodeTest()
 				Message = "Async method UseMyTask should take a CancellationToken parameter.",
 				Locations = [new DiagnosticResultLocation("Test0.cs", 28, 16)]
 			},
+			new DiagnosticResult(analyzer)
+			{
+				Message = "Async method NestedMethodAsync should take a CancellationToken parameter.",
+				Locations = [new DiagnosticResultLocation("Test0.cs", 32, 15)]
+			},
 		];
 
 		this.VerifyCSharpDiagnostic(InvalidCode, expected);
@@ -245,6 +255,11 @@ public class Test
 				public Awaitable TryAwaitable(CancellationToken cancellationToken) { return new Awaitable(); }
 
 				public MyTask UseMyTask(CancellationToken cancellationToken) => new();
+
+				private class Nested
+				{
+					public Task NestedMethodAsync(string? text, CancellationToken cancellationToken) => Task.CompletedTask;
+				}
 			}
 			""" + SharedCode;
 
@@ -283,6 +298,11 @@ public class Test
 				public Awaitable TryAwaitable(CancellationToken cancellationToken = default) { return new Awaitable(); }
 
 				public MyTask UseMyTask(CancellationToken cancellationToken = default) => new();
+
+				private class Nested
+				{
+					public Task NestedMethodAsync(string? text, CancellationToken cancellationToken = default) => Task.CompletedTask;
+				}
 			}
 			""" + SharedCode;
 

tests/Menees.Analyzers.Test/Menees.Analyzers.Settings.xml

@@ -58,7 +58,7 @@
 		<Binary MinSize="5" GroupSize="4" />
 	</DigitSeparators>
 
-	<SupportAsyncCancellationToken CheckPrivateMethods="true">
+	<SupportAsyncCancellationToken CheckPrivateMethods="true" CheckPrivateTypes="true">
 		<Properties>
 			<Property>CancellationToken</Property>
 			<Property>Cancellation</Property>