changes severity level, added a voilation condition and other minor changes.

Author: Kapil Borle

RuleDocumentation/AvoidNullOrEmptyHelpMessageAttribute.md

@@ -1,5 +1,5 @@
 #AvoidNullOrEmtpyHelpMessageAttribute
-**Severity Level: Error**
+**Severity Level: Warning**
 
 
 ##Description
@@ -12,12 +12,32 @@ To fix a violation of this rule, please set its value to a non-empty string.
 
 ##Example
 
-Wrong：
+Wrong:
 
-Function BadFuncEmtpyHelpMessage
+Function BadFuncEmtpyHelpMessageEmpty
 {
 	Param(
-		[Parameter(HelpMessage="")]
+		[Parameter(HelpMessage='')]
+		[String] $Param
+	)
+
+	$Param
+}
+
+Function BadFuncEmtpyHelpMessageNull
+{
+	Param(
+		[Parameter(HelpMessage=$null)]
+		[String] $Param
+	)
+
+	$Param
+}
+
+Function BadFuncEmtpyHelpMessageNoAssignment
+{
+	Param(
+		[Parameter(HelpMessage)]
 		[String] $Param
 	)
 
@@ -30,7 +50,7 @@ Correct:
 Function GoodFuncEmtpyHelpMessage
 {
 	Param(
-		[Parameter(HelpMessage="This is help.")]
+		[Parameter(HelpMessage='This is helpful')]
 		[String] $Param
 	)
 

Rules/AvoidNullOrEmptyHelpMessageAttribute.cs

@@ -21,13 +21,13 @@
 namespace Microsoft.Windows.PowerShell.ScriptAnalyzer.BuiltinRules
 {
     /// <summary>
-    /// AvoidUsingNullOrEmptyHelpMessageParameter: Check if the HelpMessage parameter is set to a non-empty string.
+    /// AvoidUsingNullOrEmptyHelpMessageAttribute: Check if the HelpMessage parameter is set to a non-empty string.
     /// </summary>
     [Export(typeof(IScriptRule))]
     public class AvoidNullOrEmptyHelpMessageAttribute : IScriptRule
     {               
         /// <summary>
-        /// AvoidUsingNullOrEmptyHelpMessageParameter: Check if the HelpMessage parameter is set to a non-empty string.
+        /// AvoidUsingNullOrEmptyHelpMessageAttribute: Check if the HelpMessage parameter is set to a non-empty string.
         /// </summary>
         public IEnumerable<DiagnosticRecord> AnalyzeScript(Ast ast, string fileName)
         {
@@ -39,32 +39,41 @@ public IEnumerable<DiagnosticRecord> AnalyzeScript(Ast ast, string fileName)
             foreach (FunctionDefinitionAst funcAst in functionAsts)
             {
                 if (funcAst.Body == null || funcAst.Body.ParamBlock == null
-                        || funcAst.Body.ParamBlock.Attributes == null || funcAst.Body.ParamBlock.Parameters == null)               
+                        || funcAst.Body.ParamBlock.Attributes == null || funcAst.Body.ParamBlock.Parameters == null)
+                {
                     continue;
+                }
 
                 foreach (var paramAst in funcAst.Body.ParamBlock.Parameters)
                 {                        
                     foreach (var paramAstAttribute in paramAst.Attributes)
                     {
                         if (!(paramAstAttribute is AttributeAst))
+                        {
                             continue;
+                        }
 
                         var namedArguments = (paramAstAttribute as AttributeAst).NamedArguments;
 
                         if (namedArguments == null)
+                        {
                             continue;
+                        }
 
                         foreach (NamedAttributeArgumentAst namedArgument in namedArguments)
                         {
-                            if (!(String.Equals(namedArgument.ArgumentName, "HelpMessage", StringComparison.OrdinalIgnoreCase))
-                                 || namedArgument.ExpressionOmitted)
+                            if (!(namedArgument.ArgumentName.Equals("HelpMessage", StringComparison.OrdinalIgnoreCase)))
+                            {
                                 continue;
+                            }
 
                             string errCondition;
-                            if (namedArgument.Argument.Extent.Text.Equals("\"\""))
+                            if (namedArgument.ExpressionOmitted
+                                    || namedArgument.Argument.Extent.Text.Equals("\"\"")
+                                    || namedArgument.Argument.Extent.Text.Equals("\'\'"))
                             {
                                 errCondition = "empty";
-                            }
+                            }                                                        
                             else if (namedArgument.Argument.Extent.Text.Equals("$null", StringComparison.OrdinalIgnoreCase))
                             {
                                 errCondition = "null";
@@ -134,7 +143,7 @@ public SourceType GetSourceType()
         /// <returns></returns>
         public RuleSeverity GetSeverity()
         {
-            return RuleSeverity.Error;
+            return RuleSeverity.Warning;
         }
 
         /// <summary>

Tests/Rules/AvoidNullOrEmptyHelpMessageAttribute.ps1

@@ -67,4 +67,37 @@ function BadFuncEmptyHelpMessageNoCmdletBinding
     )
     $Param1
     $Param2 = "test"
+}
+
+
+# same as BadFunc but this one has no cmdletbinding
+function BadFuncEmptyHelpMessageNoCmdletBindingSingleQoutes
+{    
+    param(
+        # this has an empty string
+        [Parameter(HelpMessage='')]          
+        [string] $Param1="String",
+        
+        # this parameter has no default value
+        [Parameter(HelpMessage="This is helpful.")]          
+        [string] $Param2
+    )
+    $Param1
+    $Param2 = "test"
+}
+
+# same as BadFunc but this one has no cmdletbinding
+function BadFuncEmptyHelpMessageNoCmdletBindingNoAssignment
+{    
+    param(
+        # this has an empty string
+        [Parameter(HelpMessage)]          
+        [string] $Param1="String",
+        
+        # this parameter has no default value
+        [Parameter(HelpMessage="This is helpful.")]          
+        [string] $Param2
+    )
+    $Param1
+    $Param2 = "test"
 }

Tests/Rules/AvoidNullOrEmptyHelpMessageAttribute.tests.ps1

@@ -8,7 +8,7 @@ $noViolations = Invoke-ScriptAnalyzer "$directory\AvoidNullOrEmptyHelpMessageAtt
 Describe "AvoidNullOrEmptyHelpMessageAttribute" {
     Context "When there are violations" {
         It "detects the violations" {
-            $violations.Count | Should Be 4
+            $violations.Count | Should Be 6
         }
 
         It "has the correct description message" {