PowerShell / PowerShell/PSScriptAnalyzer
Rule request: Warning if `Set`/`Get-Variable` is invoked with only the basic `-Name`/`-Value` parameters
Nessuno ha ancora preso questa issue.
- Lingua principale
- C#
- Stelle
- 2.2k
- Fork
- 414
- Merge medio
- 13h 1m
- PR unite (30g)
- 2
Descrizione
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
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Inizia esaminando le implementazioni e i test esistenti delle regole di PSScriptAnalyzer, quindi traccia il modo in cui vengono analizzate le chiamate a Get-Variable, Set-Variable e New-Variable. Definisci la condizione di avviso per le chiamate che usano solo parametri di base nome/valore e l’esenzione per un parametro di ambito esplicito; il lavoro è completo quando la regola e i relativi test coprono questi casi.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- powershell
- Ambito
- tooling
- Tipo di issue
- Funzionalità
- Difficoltà
- 4/5
- Tempo stimato
- 3-5 giorni
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 35/100