PowerShell / PowerShell/PSScriptAnalyzer

Need link to RuleDocumentation with PSSA results

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

还没有人认领这个 Issue。

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

描述

It will be great if there is a hyperlink in the output pointing to rule documentation for guidelines.

Invoke-ScriptAnalyzer C:\Temp\temp.ps1 | fl * -f

Line : 38
Column : 1
Message : The variable 'src1' is assigned but never used.
Extent : $src1
RuleName : PSUseDeclaredVarsMoreThanAssignments
Severity : Warning
ScriptName : temp.ps1
ScriptPath : C:\Temp\temp.ps1
RuleSuppressionID : src1
SuggestedCorrections :

Line : 54
Column : 1
Message : The variable 'src2' is assigned but never used.
Extent : $src2
RuleName : PSUseDeclaredVarsMoreThanAssignments
Severity : Warning
ScriptName : temp.ps1
ScriptPath : C:\Temp\temp.ps1
RuleSuppressionID : src2
SuggestedCorrections :

贡献指南

打开贡献指南

从这里开始

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

调研方向

从 issue 中显示的 Invoke-ScriptAnalyzer 输出开始,跟踪每条诊断信息(尤其是 RuleName PSUseDeclaredVarsMoreThanAssignments)的格式化方式。确定如何在该输出中将 RuleDocumentation 显示为超链接,然后验证显示的诊断信息包含有效的文档链接。

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

评估

技术栈
csharp, powershell
领域
tooling
Issue 类型
功能
难度
3/5
预计耗时
1-2 天
活跃度
停滞
描述清晰度
基本清楚
新手友好度
25/100

把新 issue 发到你的邮箱

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