It doesn't seem possible to fix this with parametersets without making a breaking change.
If there's no default parameterset set then the parameter binding can't resolve the parameterset in scenarios like Write-Progress -Activity "Something" -Id 1 -Completed.
If it's set to the current parameterset then it will prompt for an Activity value for Write-Progress -Completed.
If it's set to the new parameterset then it will prompt for a Completed value for Write-Progress -Activity "Something"

It seems like the only option left is to keep the current parameterset and simply make Activity optional, then if no value is provided either provide a default value, or throw an error unless it's a Completed progress record.

I'll queue this up for discussion on Cmdlets WG

This script example seems to work?

[cmdletbinding(DefaultParameterSetName='two')]
param(
	[parameter(ParameterSetName='one', mandatory=$true)]
	[parameter(ParameterSetName='two', mandatory=$false)]
	[string]$activity,

	[parameter(ParameterSetName='two')]
	[switch]$completed
)

$activity
$completed

That's not an accurate example though. Completed still needs to exist in the old parameter set so we don't break backwards compatibility with scripts like Write-Progress -Activity bla -SecondsRemaining 0 -Completed.

This example is more accurate:

function Write-Progress2
{
    [CmdletBinding(DefaultParameterSetName = "two")]
    Param
    (
	    [parameter(ParameterSetName='one', mandatory=$true)]
	    [parameter(ParameterSetName='two', mandatory=$false)]
	    [string]$activity,

        [parameter(ParameterSetName='one', Mandatory = $false)]
	    [parameter(ParameterSetName='two', Mandatory = $false)]
	    [switch]$completed
    )
    $PSCmdlet.ParameterSetName
}

but by making parameter set "two" the default set and the "completed" switch optional we allow people to call it without any parameters at all: Write-Progress2. We can fix that by making the switch mandatory but then calling it with Write-Progress2 -Activity bla will default to set 2 and prompt for a value for the "completed" parameter.

This pull request has been automatically marked as Review Needed because it has been there has not been any activity for 7 days.
Maintainer, please provide feedback and/or mark it as Waiting on Author

@PowerShell/wg-powershell-cmdlets reviewed this. We agreed to make -Activity not mandatory and allow null/empty value. We understand that new scripts using this will cause older PowerShell to prompt to fill in this parameter, but proper documentation can alleviate this.

This pull request has been automatically marked as Review Needed because it has been there has not been any activity for 7 days.
Maintainer, please provide feedback and/or mark it as Waiting on Author

@PowerShell/wg-powershell-cmdlets reviewed this. We agreed to make -Activity not mandatory and allow null/empty value. We understand that new scripts using this will cause older PowerShell to prompt to fill in this parameter, but proper documentation can alleviate this.

@SteveL-MSFT Did you discuss Clear-Progress instead of the change?

This pull request has been automatically marked as Review Needed because it has been there has not been any activity for 7 days.
Maintainer, please provide feedback and/or mark it as Waiting on Author

@iSazonov no, Clear-Progress didn't come up in the WG discussion. Let me bring that up to the WG, as that would avoid any breaking change concerns.

@SteveL-MSFT @iSazonov If you decide to go that route I think a better verb choice would be Complete, as in Complete-Progress.

This PR has 11 quantified lines of changes. In general, a change size of upto 200 lines is ideal for the best PR experience!

Label      : Extra Small
Size       : +7 -4
Percentile : 4.4%

Total files changed: 2

Change summary by file extension:
.cs : +6 -3
.ps1 : +1 -1

Was this comment helpful? 👍  👌  👎 (Email)
Customize PullRequestQuantifier for this repository.