PowerShell / PowerShell/PSScriptAnalyzer

Rule request: AvoidUsingOutNull

未關閉
#2,110 0 則留言 2 個 reaction 已指派 0 人 在 GitHub 檢視

還沒有人認領這個 Issue。

主要語言
C#
星號
2.2k
分支
415
平均合併
13 小時 1 分鐘
30 天內合併 PR
2

描述

Summary of the new feature

I want PSScriptAnalyzer to flag uses of Out-Null for output suppression so that I can maintain consistent code style and potentially gain minor performance improvements.

Currently, many PowerShell scripts use | Out-Null to suppress command output, but there are alternative approaches like [void], > $null, or assignment to $null that are stylistically preferred by many developers. While the performance difference is minimal, having a consistent approach to output suppression improves code readability and maintainability.

Proposed technical implementation details (optional)

  • Rule Name: AvoidUsingOutNull
  • Severity: Information (since this is primarily a style preference)
  • Category: Style
  • Detection: Flag any pipeline that ends with | Out-Null
  • Suggested alternatives:
    • [void](command)
    • command > $null
    • $null = command
  • Example violation: Get-Process | Out-Null
  • Example fix: [void](Get-Process) or Get-Process > $null

The rule should provide informational messages suggesting these alternatives while acknowledging that this is primarily a stylistic choice rather than a critical performance issue.

What is the latest version of PSScriptAnalyzer at the point of writing

1.24.0

貢獻指南

開啟貢獻指南

從這裡開始

  1. 先讀完整個 Issue,再讀專案的貢獻指南。
  2. 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
  3. Fork 儲存庫,在一個分支上完成修改。
  4. 送出 Pull Request,並在描述裡引用這個 Issue 編號。

研究方向

找出可比較的 PSScriptAnalyzer 規則及其測試,然後檢查規則名稱、嚴重性、類別、診斷資訊和管線模式是如何表示的。當以 Out-Null 結尾的管線產生帶有建議替代方案的資訊性 Style 診斷,而其他輸出抑制形式不受影響時,即表示完成。

由索引模型根據 Issue 內容生成。

評估

技術堆疊
csharp, powershell
領域
tooling
Issue 類型
功能
難度
3/5
預估耗時
1-2 天
活躍度
停滯
描述清晰度
基本清楚
新手友好度
45/100

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。