Align message to behavior for MA0157 (#783)

meziantou · Jan 10, 2025 · c939d72 · c939d72
1 parent 54e9030
commit c939d72
Show file tree

Hide file tree

Showing 7 changed files with 10 additions and 10 deletions.
diff --git a/README.md b/README.md
@@ -172,7  172,7 @@ If you are already using other analyzers, you can check [which rules are duplica
 |[MA0154](https://github.com/meziantou/Meziantou.Analyzer/blob/main/docs/Rules/MA0154.md)|Design|Use langword in XML comment|ℹ️|✔️|✔️|
 |[MA0155](https://github.com/meziantou/Meziantou.Analyzer/blob/main/docs/Rules/MA0155.md)|Design|Do not use async void methods|⚠️|❌|❌|
 |[MA0156](https://github.com/meziantou/Meziantou.Analyzer/blob/main/docs/Rules/MA0156.md)|Design|Use 'Async' suffix when a method returns IAsyncEnumerable\<T\>|⚠️|❌|❌|
-|[MA0157](https://github.com/meziantou/Meziantou.Analyzer/blob/main/docs/Rules/MA0157.md)|Design|Do not use 'Async' suffix when a method does not return IAsyncEnumerable\<T\>|⚠️|❌|❌|
 |[MA0157](https://github.com/meziantou/Meziantou.Analyzer/blob/main/docs/Rules/MA0157.md)|Design|Do not use 'Async' suffix when a method returns IAsyncEnumerable\<T\>|⚠️|❌|❌|
 |[MA0158](https://github.com/meziantou/Meziantou.Analyzer/blob/main/docs/Rules/MA0158.md)|Performance|Use System.Threading.Lock|⚠️|✔️|❌|
 |[MA0159](https://github.com/meziantou/Meziantou.Analyzer/blob/main/docs/Rules/MA0159.md)|Performance|Use 'Order' instead of 'OrderBy'|ℹ️|✔️|✔️|
 |[MA0160](https://github.com/meziantou/Meziantou.Analyzer/blob/main/docs/Rules/MA0160.md)|Performance|Use ContainsKey instead of TryGetValue|ℹ️|✔️|❌|

diff --git a/docs/README.md b/docs/README.md
@@ -156,7  156,7 @@
 |[MA0154](https://github.com/meziantou/Meziantou.Analyzer/blob/main/docs/Rules/MA0154.md)|Design|Use langword in XML comment|<span title='Info'>ℹ️</span>|✔️|✔️|
 |[MA0155](https://github.com/meziantou/Meziantou.Analyzer/blob/main/docs/Rules/MA0155.md)|Design|Do not use async void methods|<span title='Warning'>⚠️</span>|❌|❌|
 |[MA0156](https://github.com/meziantou/Meziantou.Analyzer/blob/main/docs/Rules/MA0156.md)|Design|Use 'Async' suffix when a method returns IAsyncEnumerable\<T\>|<span title='Warning'>⚠️</span>|❌|❌|
-|[MA0157](https://github.com/meziantou/Meziantou.Analyzer/blob/main/docs/Rules/MA0157.md)|Design|Do not use 'Async' suffix when a method does not return IAsyncEnumerable\<T\>|<span title='Warning'>⚠️</span>|❌|❌|
 |[MA0157](https://github.com/meziantou/Meziantou.Analyzer/blob/main/docs/Rules/MA0157.md)|Design|Do not use 'Async' suffix when a method returns IAsyncEnumerable\<T\>|<span title='Warning'>⚠️</span>|❌|❌|
 |[MA0158](https://github.com/meziantou/Meziantou.Analyzer/blob/main/docs/Rules/MA0158.md)|Performance|Use System.Threading.Lock|<span title='Warning'>⚠️</span>|✔️|❌|
 |[MA0159](https://github.com/meziantou/Meziantou.Analyzer/blob/main/docs/Rules/MA0159.md)|Performance|Use 'Order' instead of 'OrderBy'|<span title='Info'>ℹ️</span>|✔️|✔️|
 |[MA0160](https://github.com/meziantou/Meziantou.Analyzer/blob/main/docs/Rules/MA0160.md)|Performance|Use ContainsKey instead of TryGetValue|<span title='Info'>ℹ️</span>|✔️|❌|
@@ -641,7  641,7 @@ dotnet_diagnostic.MA0155.severity = none
 # MA0156: Use 'Async' suffix when a method returns IAsyncEnumerable<T>
 dotnet_diagnostic.MA0156.severity = none
 
-# MA0157: Do not use 'Async' suffix when a method does not return IAsyncEnumerable<T>
 # MA0157: Do not use 'Async' suffix when a method returns IAsyncEnumerable<T>
 dotnet_diagnostic.MA0157.severity = none
 
 # MA0158: Use System.Threading.Lock
@@ -1137,7  1137,7 @@ dotnet_diagnostic.MA0155.severity = none
 # MA0156: Use 'Async' suffix when a method returns IAsyncEnumerable<T>
 dotnet_diagnostic.MA0156.severity = none
 
-# MA0157: Do not use 'Async' suffix when a method does not return IAsyncEnumerable<T>
 # MA0157: Do not use 'Async' suffix when a method returns IAsyncEnumerable<T>
 dotnet_diagnostic.MA0157.severity = none
 
 # MA0158: Use System.Threading.Lock

diff --git a/docs/Rules/MA0157.md b/docs/Rules/MA0157.md
@@ -1,4  1,4 @@
-# MA0157 - Do not use 'Async' suffix when a method does not return IAsyncEnumerable\<T\>
 # MA0157 - Do not use 'Async' suffix when a method returns IAsyncEnumerable\<T\>
 
 Methods that do not return `IAsyncEnumerable<T>` should not have the Async suffix.
 

diff --git a/src/Meziantou.Analyzer.Pack/configuration/default.editorconfig b/src/Meziantou.Analyzer.Pack/configuration/default.editorconfig
@@ -467,7  467,7 @@ dotnet_diagnostic.MA0155.severity = none
 # MA0156: Use 'Async' suffix when a method returns IAsyncEnumerable<T>
 dotnet_diagnostic.MA0156.severity = none
 
-# MA0157: Do not use 'Async' suffix when a method does not return IAsyncEnumerable<T>
 # MA0157: Do not use 'Async' suffix when a method returns IAsyncEnumerable<T>
 dotnet_diagnostic.MA0157.severity = none
 
 # MA0158: Use System.Threading.Lock

diff --git a/src/Meziantou.Analyzer.Pack/configuration/none.editorconfig b/src/Meziantou.Analyzer.Pack/configuration/none.editorconfig
@@ -467,7  467,7 @@ dotnet_diagnostic.MA0155.severity = none
 # MA0156: Use 'Async' suffix when a method returns IAsyncEnumerable<T>
 dotnet_diagnostic.MA0156.severity = none
 
-# MA0157: Do not use 'Async' suffix when a method does not return IAsyncEnumerable<T>
 # MA0157: Do not use 'Async' suffix when a method returns IAsyncEnumerable<T>
 dotnet_diagnostic.MA0157.severity = none
 
 # MA0158: Use System.Threading.Lock

diff --git a/...Meziantou.Analyzer/Rules/MethodsReturningAnAwaitableTypeMustHaveTheAsyncSuffixAnalyzer.cs b/...Meziantou.Analyzer/Rules/MethodsReturningAnAwaitableTypeMustHaveTheAsyncSuffixAnalyzer.cs
@@ -42,8  42,8 @@ public sealed class MethodsReturningAnAwaitableTypeMustHaveTheAsyncSuffixAnalyze
 
     private static readonly DiagnosticDescriptor NotAsyncSuffixRuleAsyncEnumerable = new(
         RuleIdentifiers.MethodsNotReturningIAsyncEnumerableMustNotHaveTheAsyncSuffix,
-        title: "Do not use 'Async' suffix when a method does not return IAsyncEnumerable<T>",
-        messageFormat: "Method not returning IAsyncEnumerable<T> must not use the 'Async' suffix",
         title: "Do not use 'Async' suffix when a method returns IAsyncEnumerable<T>",
         messageFormat: "Method returning IAsyncEnumerable<T> must not use the 'Async' suffix",
         RuleCategories.Design,
         DiagnosticSeverity.Warning,
         isEnabledByDefault: false,

diff --git a/...Analyzer.Test/Rules/MethodsReturningAnAwaitableTypeMustHaveTheAsyncSuffixAnalyzerTests.cs b/...Analyzer.Test/Rules/MethodsReturningAnAwaitableTypeMustHaveTheAsyncSuffixAnalyzerTests.cs
@@ -157,7  157,7 @@ class TypeName
                      System.Collections.Generic.IAsyncEnumerable<int> {|MA0157:FooAsync|}() => throw null;
                  }
                  """)
-              .ShouldReportDiagnosticWithMessage("Method not returning IAsyncEnumerable<T> must not use the 'Async' suffix")
               .ShouldReportDiagnosticWithMessage("Method returning IAsyncEnumerable<T> must not use the 'Async' suffix")
               .ValidateAsync();
 
     [Fact]