PowerShell / PowerShell/PSScriptAnalyzer
Rule request: Warning if `Set`/`Get-Variable` is invoked with only the basic `-Name`/`-Value` parameters
Chưa có ai nhận issue này.
- Ngôn ngữ chính
- C#
- Star
- 2.2k
- Fork
- 414
- Merge trung bình
- 13 giờ 1 phút
- Pull request đã merge (30 ngày)
- 2
Mô tả
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
Hướng dẫn đóng góp
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Hướng nghiên cứu
Bắt đầu bằng cách xem xét các triển khai quy tắc và các bài kiểm thử hiện có của PSScriptAnalyzer, sau đó lần theo cách các lệnh gọi đến Get-Variable, Set-Variable và New-Variable được phân tích. Xác định điều kiện cảnh báo cho các lệnh gọi chỉ sử dụng các tham số tên/giá trị cơ bản và trường hợp miễn trừ đối với tham số phạm vi rõ ràng; công việc được xem là hoàn tất khi quy tắc và các bài kiểm thử của nó bao quát các trường hợp đó.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Đánh giá
- Công nghệ
- powershell
- Lĩnh vực
- tooling
- Loại issue
- Tính năng
- Độ khó
- 4/5
- Thời gian dự kiến
- 3-5 ngày
- Mức độ hoạt động
- Đình trệ
- Độ rõ ràng
- Khá rõ ràng
- Mức phù hợp với người mới
- 35/100