PowerShell / PowerShell/PSScriptAnalyzer

"Reserved prefixes" rule

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

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

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ả

Summary of the new feature

A while ago, the PowerShell extension had an issue open on it because

Get-Help Get-AdUser -Online

and

Get-Help Get-AdFoo -Online

(note, Foo is used to make it obvious and I forget what the actual noun was)

Were not giving the same result...

As it turned out, its because Get-AdFoo was from a module from the Gallery... Where Get-AdUser comes from the inbox Active Directory module.

Personally, I think it's quite dodgy to overload such a crucial prefix like Ad and we should warn users that certain prefixes are used already in very critical modules.

Proposed technical implementation details (optional)

A rule that gives a warning that says "you probably shouldn't use this prefix because it's already used by X"

Or something to that effect.

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

1.18.0

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

Chưa xác định được tệp triển khai hoặc bài kiểm thử nào. Hãy bắt đầu bằng cách tìm các điểm vào của những rule PSScriptAnalyzer hiện có và xem xét cách tên lệnh PowerShell và các module được biểu diễn; sau đó làm rõ nguồn của tiền tố dành riêng, hành vi cảnh báo và các tiêu chí chấp nhận trước khi triển khai hoặc kiểm thử rule.

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
tooling
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
Cần làm rõ
Mức phù hợp với người mới
25/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.