Merge pull request #432 from PowerShell/SingularNounRuleBugFixBranch

Improved heuristics for Singular noun rule

Author: raghushantha

Engine/PSScriptAnalyzer.psd1

@@ -11,7 +11,7 @@ Author = 'Microsoft Corporation'
 RootModule = 'PSScriptAnalyzer.psm1'
 
 # Version number of this module.
-ModuleVersion = '1.3.0'
+ModuleVersion = '1.3.1'
 
 # ID used to uniquely identify this module
 GUID = '324fc715-36bf-4aee-8e58-72e9b4a08ad9'

Rules/UseSingularNouns.cs

@@ -17,6 +17,7 @@
 using Microsoft.Windows.PowerShell.ScriptAnalyzer.Generic;
 using System.ComponentModel.Composition;
 using System.Globalization;
+using System.Text.RegularExpressions;
 
 namespace Microsoft.Windows.PowerShell.ScriptAnalyzer.BuiltinRules
 {
@@ -46,6 +47,11 @@ public IEnumerable<DiagnosticRecord> AnalyzeScript(Ast ast, string fileName) {
                 {
                     funcNamePieces = funcAst.Name.Split(funcSeperator);
                     String noun = funcNamePieces[1];
+
+                    // Convert the noun part of the function into a series of space delimited words
+                    // This helps the PluralizationService to provide an accurate determination about the plurality of the string
+                    noun = SplitCamelCaseString(noun);
+
                     var ps = System.Data.Entity.Design.PluralizationServices.PluralizationService.CreateService(CultureInfo.GetCultureInfo("en-us"));
 
                     if (!ps.IsSingular(noun) && ps.IsPlural(noun))
@@ -108,6 +114,19 @@ public string GetSourceName()
         {
             return string.Format(CultureInfo.CurrentCulture, Strings.SourceName);
         }
+
+        /// <summary>
+        /// SplitCamelCaseString: Splits a Camel Case'd string into individual words with space delimited
+        /// </summary>
+        private string SplitCamelCaseString(string input)
+        {
+            if (String.IsNullOrEmpty(input))
+            {
+                return String.Empty;
+            }
+
+            return Regex.Replace(input, "([A-Z])", " $1", RegexOptions.Compiled).Trim();
+        }
     }
 
 }

Tests/Rules/GoodCmdlet.ps1

@@ -260,4 +260,19 @@ function Get-Reserved*
     End
     {
     }
+}
+
+<#
+.Synopsis
+   function that has a noun that is singular  
+.DESCRIPTION
+   
+.EXAMPLE
+   
+.EXAMPLE
+   
+#>
+function Get-MyWidgetStatus
+{
+
 }