PowerShell / PowerShell/PSScriptAnalyzer

UseShouldProcessForStateChangingFunctions should prove that a function changes system state.

Đang mở
#206 3 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Issue - Bug Issue - New Rule Up-for-Grabs
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ả

Right now, the UseShouldProcessForStateChangingFunctions rule only looks at the name of the function (the verb) in order to determine that the function changes system state.

I think the rule should look at the body of the function and see if the function uses other functions that changes system state before it issues a warning.

If not, then I think that functions with the "New" verb should not be considered as functions that change system state. A lot of functions from the community with the "New" verb do not change system state, but are actually just different forms of "New-Object". See, for example, the ShowUI module.

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. 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.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Hướng nghiên cứu

Bắt đầu với quy tắc UseShouldProcessForStateChangingFunctions và theo dõi cách quy tắc hiện sử dụng tên hàm để đưa ra cảnh báo. Điều tra cách quy tắc có thể kiểm tra phần thân hàm và các lệnh gọi hàm, bao gồm cả việc có nên loại trừ các hàm New-verb khi chúng không thay đổi trạng thái hệ thống hay không. Công việc được xem là hoàn tất khi quy tắc phân biệt được các hàm thay đổi trạng thái với các hàm tạo đối tượng mà không chỉ dựa vào động từ.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Đánh giá

Công nghệ
csharp, powershell
Lĩnh vực
devtools
Loại issue
Tính năng
Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
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

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.