PowerShell / PowerShell/PSScriptAnalyzer

Definitions for Information, Warning, and Error Severities

未关闭
#467 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

Area - Documentation Issue - Enhancement
主要语言
C#
星标
2.2k
派生
414
平均合并
13 小时 1 分钟
30 天内合并 PR
2

描述

In the code comments for the RuleSeverity enum, a warning does not follow PowerShell's "recommended" guidelines and Errors do not conform to PowerShell's "required" guidelines. Information rules are "recommended by PowerShell best practice".

I just posted #466 and now that I am thinking about it, I am not sure what the specific criteria is that would differentiate Warnings from Errors. For my team, at my company, we cannot have any hard coded passwords in a script, so this would definitely be an Error. However, that might not be the case for everyone everywhere.

The definitions of Warning and Error severity should be clearly defined in the documentation. I have some ideas and opinions here, as I am sure everyone in the PS community does. Would it make sense to use https://github.com/PoshCode/PowerShellPracticeAndStyle as a starting point for best practices and guidelines?

I am also wondering if it would make sense to have the ability to override severity levels for built in rules.

贡献指南

打开贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

调研方向

从 RuleSeverity 枚举注释入手,并将其当前措辞与 issue 中链接的 PowerShellPracticeAndStyle 指南进行比较。定义并记录区分 Information、Warning 和 Error 严重级别的标准,并明确内置严重级别覆盖是否在范围内。

由索引模型根据 Issue 内容生成。

评估

技术栈
powershell
领域
documentation
Issue 类型
文档
难度
5/5
预计耗时
一周以上
活跃度
停滞
描述清晰度
需要澄清
新手友好度
25/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。