Suggest setting SupportsShouldProcess to true

Author: Kapil Borle

Tests/Rules/UseSupportsShouldProcess.tests.ps1

@@ -268,6 +268,27 @@ function foo {
             $violations[0].SuggestedCorrections[0].Text | Should Be $expectedCorrection
         }
 
+        It "Suggests setting SupportsShouldProcess to `$true" {
+            $def = @'
+function foo {
+    [CmdletBinding(SupportsShouldProcess=$false)]
+    param($whatif)
+}
+'@
+            $s = " "
+            $expectedCorrection = @'
+function foo {
+    [CmdletBinding(SupportsShouldProcess=$true)]
+    param()
+}
+'@
+            $violations = Invoke-ScriptAnalyzer -ScriptDefinition $def -Settings $settings
+            $violations.Count | Should Be 1
+            $violations[0].SuggestedCorrections[0].Text | Should Be $expectedCorrection
+        }
+
+
+
 
     }
 

rules/UseSupportsShouldProcess.cs

@@ -132,15 +132,22 @@ private List<CorrectionExtent> GetCorrections(
                     correctionExtents.Add(GetCorrectionToRemoveParam(confirmIndex, parameterAsts));
                 }
 
-                AttributeAst attributeAst;
+                AttributeAst attributeAst = paramBlockAst.GetCmdletBindingAttributeAst();
 
                 // check if it has cmdletbinding attribute
-                if (TryGetCmdletBindingAttribute(paramBlockAst, out attributeAst))
+                if (attributeAst != null)
                 {
                     NamedAttributeArgumentAst shouldProcessAst = attributeAst.GetSupportsShouldProcessAst();
                     if (shouldProcessAst != null)
                     {
-
+                        ExpressionAst argAst;
+                        if (!shouldProcessAst.IsTrue(out argAst)
+                            && argAst != null)
+                        {
+                            // SupportsShouldProcess is set to something other than $true.
+                            // Set it to $true
+                            correctionExtents.Add(GetCorrectionsToSetShouldProcessToTrue(argAst));
+                        }
                     }
                     else
                     {
@@ -198,6 +205,17 @@ private List<CorrectionExtent> GetCorrections(
             return result;
         }
 
+        private CorrectionExtent GetCorrectionsToSetShouldProcessToTrue(ExpressionAst argAst)
+        {
+            return new CorrectionExtent(
+                argAst.Extent.StartLineNumber,
+                argAst.Extent.EndLineNumber,
+                argAst.Extent.StartColumnNumber,
+                argAst.Extent.EndColumnNumber,
+                "$true",
+                argAst.Extent.File);
+        }
+
         private CorrectionExtent GetCorrectionToAddParamBlock(
             FunctionDefinitionAst funcDefnAst,
             ParameterAst[] parameterAsts)
@@ -281,14 +299,6 @@ private CorrectionExtent Normalize(
                  correctionExtent.Description);
         }
 
-        private static bool TryGetCmdletBindingAttribute(
-            ParamBlockAst paramBlockAst,
-            out AttributeAst attributeAst)
-        {
-            attributeAst = paramBlockAst.GetCmdletBindingAttributeAst();
-            return attributeAst != null;
-        }
-
         private static CorrectionExtent GetCorrectionToAddAttribute(ParamBlockAst paramBlockAst)
         {
             return new CorrectionExtent(