PowerShell / PowerShell/PSScriptAnalyzer
Improve rule suppression documentation
未關閉
還沒有人認領這個 Issue。
Area - Documentation
Issue - Enhancement
- 主要語言
- C#
- 星號
- 2.2k
- 分支
- 414
- 平均合併
- 13 小時 1 分鐘
- 30 天內合併 PR
- 2
描述
Existing documentation doesn't provide any information regarding rule-wise behavior of code suppression.
For example, PSSA cannot suppress PSAvoidUsingUserNameAndPassWordParams violations based on given rulesuppressionid.
Configuration Foo
{
[Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSAvoidUsingUserNameAndPassWordParams", "UserName", Scope="Function")]
[Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSAvoidUsingUserNameAndPassWordPara", "EncryptedPassword", Scope="Function")]
param (
[Parameter(Mandatory)]
[String]$UserName,
[Parameter(Mandatory)]
[String]$Password
)
}
貢獻指南
從這裡開始
- 先讀完整個 Issue,再讀專案的貢獻指南。
- 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
- Fork 儲存庫,在一個分支上完成修改。
- 送出 Pull Request,並在描述裡引用這個 Issue 編號。
研究方向
該 issue 沒有指定文件檔案或測試。首先找到現有的規則抑制文件,並檢查 PSSA 如何處理所示的 SuppressMessageAttribute 範例,包括 rulesuppressionid 值。完成的標準是:文件說明依規則進行抑制的行為,並涵蓋 PSavoidUsingUserNameAndPassWordParams 範例。
由索引模型根據 Issue 內容生成。
評估
- 技術堆疊
- powershell
- 領域
- documentation
- Issue 類型
- 文件
- 難度
- 3/5
- 預估耗時
- 1-2 天
- 活躍度
- 停滯
- 描述清晰度
- 基本清楚
- 新手友好度
- 45/100