chocolatey / chocolatey/choco

Deprecate `Passthru` parameter on `Get-WebFile` PowerShell helper

Open
#2,640 2 comments 0 reactions 0 assignees View on GitHub
0 - Triaging Enhancement
Dominant language
C#
Stars
11.5k
Forks
960
PR merge metrics
No merged PRs in 30d

Description

## Is Your Feature Request Related To A Problem? Please describe.

In version 0.9.10 the parameter `Passthru` was changed to a recommendation of not using it, and had been left due to backwards compatibility.
As this is recommended to not be used, we should deprecate its use and output a warning if it is used with a pending removal in the next major version.

## Describe The Solution. Why is it needed?

It makes sense to deprecate anything that we do recommend to not be used, instead of purely leaving it as a comment.

## Additional Context.

Link to DO NOT USE comment: https://github.com/chocolatey/choco/blob/19d7dd10d2cb4392afd157d52ccc7067f69611e7/src/chocolatey.resources/helpers/functions/Get-WebFile.ps1#L60-L61

## Related Issues

TODO: Add a link to an issue that will eventually remove this deprecation.

Contributor guide

Open the contributing guide

Research direction

Start with src/chocolatey.resources/helpers/functions/Get-WebFile.ps1, especially the DO NOT USE comment at lines 60-61. Trace how the Passthru parameter is handled and inspect nearby helper patterns before defining the deprecation behavior; done means using Passthru emits a warning that it is pending removal in the next major version.

Written by the indexing model from the issue text.

Assessment

Tech stack
powershell
Domain
cli
Issue type
Feature
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.