PowerShell / PowerShell/PSScriptAnalyzer

AvoidUsingPlainTextForPassword docs do not cover all checked parameter names

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

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

Area - Documentation Area - Rules Up-for-Grabs
主要言語
C#
スター
2.2k
フォーク
414
平均マージ
13時間 1分
マージ済み PR(30日)
2

説明

I have a script parameter that holds a path to the encrypted credential file named $CredentialFile for which I get the warning:

Parameter '$CredentialFile' should use SecureString, otherwise this will expose sensitive information. See ConvertTo-SecureString for more information.

There is no reason for me use SecureString here and I cannot think of a better alternative to the parameter name, so it would be nice to suppress this message for this particular instance, but not to the whole file or project. Besides, the documentation for PSAvoidUsingPlainTextForPassword needs to include Credential and whatever other strings it gets triggered of, since it only mentions one word: Password.

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

調査の方向性

PSAvoidUsingPlainTextForPassword ルールとそのドキュメントエントリから始めてください。issue にはファイルパスやテストパスは記載されていません。CredentialFile などのパラメーター名がどのようにカバーされているかを確認し、該当するすべての名前と、ドキュメント化された動作で許可されている場合に単一の警告を抑制するサポートされた方法を説明するよう、ドキュメントを更新してください。

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

評価

技術スタック
powershell
領域
documentation, tooling
issue の種類
ドキュメント
難易度
2/5
見積もり時間
1〜3時間
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
35/100

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

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