Remove ValueFromPipeline and Positional binding from ScriptDefinition parameter of Invoke-ScriptAnalyzer. Update documentation for pipeline input

Author: liamjpeters

Engine/Commands/InvokeScriptAnalyzerCommand.cs

@@ -67,15 +67,13 @@ public string Path
         /// <summary>
         /// ScriptDefinition: a script definition in the form of a string to run rules on.
         /// </summary>
-        [Parameter(Position = 0,
+        [Parameter(
             ParameterSetName = ParameterSet_ScriptDefinition_IncludeSuppressed,
             Mandatory = true,
-            ValueFromPipeline = true,
             ValueFromPipelineByPropertyName = true)]
-        [Parameter(Position = 0,
+        [Parameter(
             ParameterSetName = ParameterSet_ScriptDefinition_SuppressedOnly,
             Mandatory = true,
-            ValueFromPipeline = true,
             ValueFromPipelineByPropertyName = true)]
         [ValidateNotNull]
         public string ScriptDefinition

Tests/Engine/ModuleHelp.Tests.ps1

@@ -240,8 +240,9 @@ Describe 'Cmdlet parameter help' {
 
 				$parameterHelpPipelineInput = if ($parameterHelp.pipelineInput -eq 'True (ByPropertyName, ByValue)') {
 					$true
-				}
-				else {
+				} elseif ($parameterHelp.pipelineInput -eq 'True (ByPropertyName)') {
+					$true
+				} else {
 					[System.Boolean]::Parse($parameterHelp.pipelineInput)
 				}
 

docs/Cmdlets/Invoke-ScriptAnalyzer.md

@@ -550,9 +550,9 @@ Parameter Sets: ScriptDefinition_IncludeSuppressed, ScriptDefinition_SuppressedO
 Aliases:
 
 Required: True
-Position: 0
+Position: Named
 Default value: None
-Accept pipeline input: True (ByPropertyName, ByValue)
+Accept pipeline input: True (ByPropertyName)
 Accept wildcard characters: False
 ```
 
@@ -687,9 +687,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
 
 ## INPUTS
 
-### None
+### String
+
+You can pipe a string representing a script path to this cmdlet. The string is bound to the `-Path` parameter by value.
+
+### ScriptBlock
 
-You cannot pipe input to this cmdlet.
+You can pipe a script block to this cmdlet. The script block is bound to the `-ScriptBlock` parameter by value.
 
 ## OUTPUTS