PowerShell / PowerShell/PSScriptAnalyzer

Need link to RuleDocumentation with PSSA results

オープン
#816 コメント 1 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

Area - Rules Issue - Enhancement Up-for-Grabs
主要言語
C#
スター
2.2k
フォーク
414
平均マージ
13時間 1分
マージ済み PR(30日)
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. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

調査の方向性

Issue に示されている Invoke-ScriptAnalyzer の出力から始め、各診断、特に RuleName PSUseDeclaredVarsMoreThanAssignments がどのようにフォーマットされているかを追跡します。その出力で RuleDocumentation をハイパーリンクとして公開する方法を確認し、表示される診断に機能するドキュメントリンクが含まれていることを検証します。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
csharp, powershell
領域
tooling
issue の種類
機能追加
難易度
3/5
見積もり時間
1〜2日
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
25/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。