Remove checking for ShouldContinue

If a cmdlet declares SupportsShouldProcess attribute, it must call ShouldProcess but calling ShouldContinue is optional.

Author: Kapil Borle

RuleDocumentation/UseShouldProcessCorrectly.md

@@ -2,17 +2,12 @@
 **Severity Level: Warning**
 
 ##Description
-Checks that if the `SupportsShouldProcess` is present, i.e, `[CmdletBinding(SupportsShouldProcess = $true)]`, and then tests if the function or cmdlet calls
-ShouldProcess or ShouldContinue; i.e `$PSCmdlet.ShouldProcess` or `$PSCmdlet.ShouldContinue`.
+If a cmdlet declares the `SupportsShouldProcess` attribute, then it should also call `ShouldProcess`. A violation is any function which either declares `SupportsShouldProcess` attribute but makes no calls to `ShouldProcess` or it calls `ShouldProcess` but does not does not declare `SupportsShouldProcess`
 
-A violation is any function where `SupportsShouldProcess` that makes no calls to `ShouldProcess` or `ShouldContinue`.
-
-Scripts with one or the other but not both will generally run into an error or unexpected behavior.
+For more information, please refer to `about_Functions_Advanced_Methods` and `about_Functions_CmdletBindingAttribute`
 
 ##How to Fix
-To fix a violation of this rule, please call `ShouldProcess` method in advanced functions when `SupportsShouldProcess` argument is present.
-Or please add `SupportsShouldProcess` argument when calling `ShouldProcess`.
-You can get more details by running `Get-Help about_Functions_CmdletBindingAttribute` and `Get-Help about_Functions_Advanced_Methods` command in Windows PowerShell.
+To fix a violation of this rule, please call `ShouldProcess` method when a cmdlet declares `SupportsShouldProcess` attribute. Or please add `SupportsShouldProcess` attribute argument when calling `ShouldProcess`.
 
 ##Example
 ###Wrong：
@@ -26,17 +21,7 @@ You can get more details by running `Get-Help about_Functions_CmdletBindingAttri
 			[Parameter(Mandatory=$true)]
 	        $Path
 	    )
-
-	    Begin
-	    {
-	    }
-	    Process
-	    {
-			"String" | Out-File -FilePath $FilePath
-	    }
-	    End
-	    {
-	    }
+		"String" | Out-File -FilePath $FilePath
 	}
 ```
 
@@ -52,22 +37,13 @@ You can get more details by running `Get-Help about_Functions_CmdletBindingAttri
 	        $Path
 	    )
 
-	    Begin
-	    {
-	    }
-	    Process
-	    {
-			if ($PSCmdlet.ShouldProcess("Target", "Operation"))
-	        {
-				"String" | Out-File -FilePath $FilePath
-			}
-	    }
-	    End
-	    {
-			if ($pscmdlet.ShouldContinue("Yes", "No"))
-			{
-				...
-        	}
-	    }
+		if ($PSCmdlet.ShouldProcess("Target", "Operation"))
+		{
+			"String" | Out-File -FilePath $FilePath
+		}
+		else
+		{
+			Write-Host ('Write "String" to file {0}' -f $FilePath)
+		}
 	}
 ```

Rules/UseShouldProcessCorrectly.cs

@@ -37,13 +37,10 @@ public class UseShouldProcessCorrectly : IScriptRule
         private List<DiagnosticRecord> diagnosticRecords;
 
         private readonly Vertex shouldProcessVertex;
-        private readonly Vertex shouldContinueVertex;
-
 
         public UseShouldProcessCorrectly()
         {
             diagnosticRecords = new List<DiagnosticRecord>();
-            shouldContinueVertex = new Vertex {name="ShouldContinue", ast=null};
             shouldProcessVertex = new Vertex {name="ShouldProcess", ast=null};
         }
 
@@ -143,8 +140,7 @@ private void FindViolations()
         /// <returns>An instance of DiagnosticRecord if it find violation, otherwise null</returns>
         private DiagnosticRecord GetViolation(Vertex v)
         {
-            bool callsShouldProcess = funcDigraph.IsConnected(v, shouldContinueVertex)
-                        || funcDigraph.IsConnected(v, shouldProcessVertex);
+            bool callsShouldProcess = funcDigraph.IsConnected(v, shouldProcessVertex);
             FunctionDefinitionAst fast = v.ast as FunctionDefinitionAst;
             if (fast == null)
             {

Tests/Rules/GoodCmdlet.ps1

@@ -22,8 +22,8 @@
 #>
 function Get-File
 {
-    [CmdletBinding(DefaultParameterSetName='Parameter Set 1', 
-                  SupportsShouldProcess=$true, 
+    [CmdletBinding(DefaultParameterSetName='Parameter Set 1',
+                  SupportsShouldProcess=$true,
                   PositionalBinding=$false,
                   HelpUri = 'http://www.microsoft.com/',
                   ConfirmImpact='Medium')]
@@ -34,17 +34,17 @@ function Get-File
     Param
     (
         # Param1 help description
-        [Parameter(Mandatory=$true, 
+        [Parameter(Mandatory=$true,
                    ValueFromPipeline=$true,
-                   ValueFromPipelineByPropertyName=$true, 
-                   ValueFromRemainingArguments=$false, 
+                   ValueFromPipelineByPropertyName=$true,
+                   ValueFromRemainingArguments=$false,
                    Position=0,
                    ParameterSetName='Parameter Set 1')]
         [ValidateNotNull()]
         [ValidateNotNullOrEmpty()]
         [ValidateCount(0,5)]
         [ValidateSet("sun", "moon", "earth")]
-        [Alias("p1")] 
+        [Alias("p1")]
         $Param1,
 
         # Param2 help description
@@ -131,8 +131,8 @@ function Get-File
 #>
 function Get-Folder
 {
-    [CmdletBinding(DefaultParameterSetName='Parameter Set 1', 
-                  SupportsShouldProcess, 
+    [CmdletBinding(DefaultParameterSetName='Parameter Set 1',
+                  SupportsShouldProcess,
                   PositionalBinding=$false,
                   HelpUri = 'http://www.microsoft.com/',
                   ConfirmImpact='Medium')]
@@ -143,17 +143,17 @@ function Get-Folder
     Param
     (
         # Param1 help description
-        [Parameter(Mandatory=$true, 
+        [Parameter(Mandatory=$true,
                    ValueFromPipeline=$true,
-                   ValueFromPipelineByPropertyName=$true, 
-                   ValueFromRemainingArguments=$false, 
+                   ValueFromPipelineByPropertyName=$true,
+                   ValueFromRemainingArguments=$false,
                    Position=0,
                    ParameterSetName='Parameter Set 1')]
         [ValidateNotNull()]
         [ValidateNotNullOrEmpty()]
         [ValidateCount(0,5)]
         [ValidateSet("sun", "moon", "earth")]
-        [Alias("p1")] 
+        [Alias("p1")]
         $Param1,
 
         # Param2 help description
@@ -279,13 +279,13 @@ function Get-Reserved*
 
 <#
 .Synopsis
-   function that has a noun that is singular  
+   function that has a noun that is singular
 .DESCRIPTION
-   
+
 .EXAMPLE
-   
+
 .EXAMPLE
-   
+
 #>
 function Get-MyWidgetStatus
 {
@@ -299,7 +299,7 @@ function Get-MyFood
 
     process
     {
-        if ($PSCmdlet.ShouldContinue("Are you sure?"))
+        if ($PSCmdlet.ShouldProcess(("Are you sure?")))
         {
         }
     }