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