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
分支
415
平均合併
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 摘要。