docs(powershell): add Output & Streams guidance discouraging Write-Host#193
Merged
Conversation
Steer authors to intent-appropriate output cmdlets (Write-Output for data, Write-Information for status, Write-Verbose/Write-Debug for diagnostics, Write-Warning/Write-Error for problems) instead of Write-Host, which cannot be captured, redirected, or suppressed (PSScriptAnalyzer PSAvoidUsingWriteHost). Document that color is a host concern: Write-Warning is auto-yellow and Write-Error auto-red, configurable via \System.Management.Automation.PSStyle in PowerShell 7.2+. Reserve Write-Host for intentional decorative interactive console UX only. Closes #192 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds an Output & Streams section to
.github/instructions/powershell.instructions.md(the guidelines previously had no output-stream guidance).Write-Host(PSScriptAnalyzerPSAvoidUsingWriteHost) because it cannot be captured, redirected, or suppressed.Write-Output-- pipeline data / return valuesWrite-Information-- human-facing status (stream 6)Write-Verbose/Write-Debug-- opt-in diagnosticsWrite-Warning/Write-Error(orthrow) -- problemsWrite-Warningis auto-yellow andWrite-Errorauto-red; tune via\System.Management.Automation.PSStyleon PowerShell 7.2+. No hand-rolled color.Write-Hostreserved for intentional decorative interactive console UX only.Documentation-only, generic, ASCII-only. No existing scripts refactored.
Closes #192