PowerShell / PowerShell/PSScriptAnalyzer

Rule request: Warning if `Set`/`Get-Variable` is invoked with only the basic `-Name`/`-Value` parameters

未關閉
#1,706 2 則留言 1 個 reaction 已指派 0 人 在 GitHub 檢視

還沒有人認領這個 Issue。

Area - Rules Issue - New Rule Up-for-Grabs
主要語言
C#
星號
2.2k
分支
415
平均合併
13 小時 1 分鐘
30 天內合併 PR
2

描述

Referring to StackOverflow questions along with: How do I automaticaly create and use variable names?.

The cmdlets:

Could completely mislead a novice PowerShell scripter in a wrong programming direction.

The general learning process of a scripter/programmer is playing with variables. Than it gets extended to list of variables like $Var1 = 'One', $Var2 = 'Two', .... The list extends further and they understand they need to automate this somehow but finding guidance for this is quiet a leap and if they ask for guidance at e.g. StackOverflow they often get a direct answer/comment in the direction of using one of these <verb>-Variable cmdlets which is not a good practice for these users and what they atempt to do or learn.

Afaik, there is no good reason to use one of these <verb>-Variable cmdlets which just -Name and -Value parameters.

e.g. Get-Variable MyVar can be replaced by $MyVar and Set-Variable MyVar 'Test' can be replaced by $MyVar = 'Test'

The only other reason to use just the -Name and -Value parameters is to create dynamic variable names (variable indirection) like:

Set-Variable "Var$i" 'Test'

Which is to my opinion a bad practice as they will be added to the same dictionary as the rest of the parameters and one might easily overwrite other general variables and lose the oversight.

Summary of the new feature

When it comes to creating a dynamic variables, a separated dictionary (in the form of a hashtable) should be created and a warning/hint could be given in that direction.

Visa verse, advanced users that know what they are doing, might simply avoid the warning by adding a specific (e.g. -Scope Script) parameter.

What is the latest version of PSScriptAnalyzer at the point of writing
1.19.1

貢獻指南

開啟貢獻指南

從這裡開始

  1. 先讀完整個 Issue,再讀專案的貢獻指南。
  2. 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
  3. Fork 儲存庫,在一個分支上完成修改。
  4. 送出 Pull Request,並在描述裡引用這個 Issue 編號。

研究方向

首先檢視現有的 PSScriptAnalyzer 規則實作和測試,然後追蹤對 Get-Variable、Set-Variable 和 New-Variable 的呼叫是如何被分析的。定義僅使用基本名稱/值參數之呼叫的警告條件,以及明確範圍參數的豁免條件;當規則及其測試涵蓋這些情況時,即表示完成。

由索引模型根據 Issue 內容生成。

評估

技術堆疊
powershell
領域
tooling
Issue 類型
功能
難度
4/5
預估耗時
3-5 天
活躍度
停滯
描述清晰度
基本清楚
新手友好度
35/100

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。