Allow suppression of PSUseSingularNouns for specific function (#1903)

* Add ruleId to PSUseSingularNouns

* Update UseSingularNouns.md

* Update UseSingularNouns.md

---------

Co-authored-by: Christoph Bergmeister <[email protected]>

Author: fflaten

Diff for: Rules/UseSingularNouns.cs

@@ -88,6 +88,7 @@ public IEnumerable<DiagnosticRecord> AnalyzeScript(Ast ast, string fileName)
                         GetName(),
                         DiagnosticSeverity.Warning,
                         fileName,
+                        funcAst.Name,
                         suggestedCorrections: new CorrectionExtent[] { GetCorrection(pluralizer, extent, funcAst.Name, noun) });
                 }
             }

Diff for: Tests/Rules/UseSingularNounsReservedVerbs.tests.ps1

@@ -86,6 +86,18 @@ Write-Output "Adding some data"
             $diagnostics.SuggestedCorrections.Text | Should -BeExactly $Correction
         }
     }
+    Context 'Suppression' {
+        It 'Can be suppressed by RuleSuppressionId' {
+            $scriptDef = @"
+function Get-Elements {
+    [System.Diagnostics.CodeAnalysis.SuppressMessageAttribute('$nounViolationName', 'Get-Elements')]
+    param()
+}
+"@
+            $warnings = @(Invoke-ScriptAnalyzer -ScriptDefinition $scriptDef)
+            $warnings.Count | Should -Be 0
+        }
+    }
 }
 
 Describe "UseApprovedVerbs" {

Diff for: docs/Rules/UseSingularNouns.md

@@ -13,6 +13,15 @@ title: UseSingularNouns
 
 PowerShell team best practices state cmdlets should use singular nouns and not plurals.
 
+Suppression allows to suppress just specific function names, for example
+
+```
+function Get-Elements {
+    [System.Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSUseSingularNouns', 'Get-Elements')]
+    Param()
+}
+```
+
 ## How
 
 Change plurals to singular.