Configurable ParameterDescription Placement and Section Requirements in PSProvideCommentHelp
Maintainer thường phản hồi trong vòng 1 ngày
Chưa có ai nhận issue này.
Đánh giá
- Độ khó
- 5/5
- Thời gian dự kiến
- Hơn một tuần
- Mức phù hợp với người mới
- 35/100
Hướng nghiên cứu
Bắt đầu bằng cách xác định rule PSProvideCommentHelp và phần xử lý cấu hình hiện có của rule. Theo dõi cách các mô tả tham số và các phần trợ giúp hiện được tìm thấy, sau đó xác định các kiểm thử của rule trước khi định nghĩa phạm vi bao phủ cho ParameterDescriptionPlacement, RequiredSections và RequiredSectionsOrderMatters. Công việc được hoàn tất khi cả hai chế độ đặt vị trí và việc xác thực các phần bắt buộc, bao gồm cả thứ tự tùy chọn, đều được thực thi nhất quán.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Mô tả
Summary of the new feature
As a user of PSScriptAnalyzer, I want to be able to configure where ParameterDescription comments appear and enforce required help sections (with optional order enforcement) in the PSProvideCommentHelp rule, so that I can align documentation with my project's standards and ensure consistency.
Proposed technical implementation details (optional)
-
Configurable ParameterDescription Placement
- Add a new configuration option for PSProvideCommentHelp called
ParameterDescriptionPlacementwith two possible values:WithCommentHelp(default): Parameter descriptions are included in the comment help block as today.InParamBlock: Parameter descriptions are placed as inline comments in the param block itself.
- The setting would control where parameter docs are generated and where the rule expects to find them.
- Add a new configuration option for PSProvideCommentHelp called
-
Required Sections and Order Enforcement
- Add a configuration option called
RequiredSections, accepting an array of section names (e.g.,["Synopsis", "Description", "Parameters"]). - Add a boolean configuration option
RequiredSectionsOrderMatters(default:false). If set totrue, the order of the sections in the array is enforced in the help comment, and the rule will fail if the order is incorrect. - If
RequiredSectionsOrderMattersis false, presence of all required sections is enforced, but order is not.
- Add a configuration option called
These options would give users more flexibility in how comment-based help is structured and validated.
What is the latest version of PSScriptAnalyzer at the point of writing
2024.6.0 (or latest at time of filing)
- Ngôn ngữ chính
- C#
- Star
- 2.2k
- Fork
- 422
- Merge trung bình
- 2 giờ 23 phút
- Pull request đã merge (30 ngày)
- 25
Chuẩn bị môi trường
Khởi chạy dev container của dự án ngay trên trình duyệt, bằng tài khoản GitHub của bạn.
- Không có Dockerfile hay tệp Docker Compose
- Có mẫu pull request
- Đọc 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.
Issue khác của PowerShell/PSScriptAnalyzer
-
Up-for-Grabs
Độ khó 1/5 1-3 giờ Mức phù hợp với người mới 78/100
PowerShell/PSScriptAnalyzer#2213 · 2 bình luận ·
Maintainer thường phản hồi trong vòng 1 ngày
-
Độ khó 4/5 1-2 ngày Mức phù hợp với người mới 18/100
PowerShell/PSScriptAnalyzer#2302 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
Độ khó 4/5 3-5 ngày Mức phù hợp với người mới 55/100
PowerShell/PSScriptAnalyzer#2300 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
Invoke-ScriptAnalyzer fails intermittently with NullReferenceException in CommandInfo.ResolveParameter (ProvideCommentHelp / AvoidReservedCharInCmdlet race on Export-ModuleMember)Có thể đã có người làm @jessehouwing đã nhận 89 ngày trước. Đang mởIssue - Bug
Độ khó 4/5 3-5 ngày Mức phù hợp với người mới 52/100
PowerShell/PSScriptAnalyzer#2229 · 6 bình luận ·
Maintainer thường phản hồi trong vòng 1 ngày
-
Độ khó 4/5 3-5 ngày Mức phù hợp với người mới 32/100
PowerShell/PSScriptAnalyzer#2222 · 2 bình luận ·
Maintainer thường phản hồi trong vòng 1 ngày
Tất cả issue của PowerShell/PSScriptAnalyzer
Issue tương tự
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 68/100
GamaEdtech/gamatrain-back#977 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
area-templates triage:bot-seen triage:needs-human
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 75/100
microsoft/aspire#22356 · 1 bình luận ·
Maintainer thường phản hồi trong vòng 1 ngày
-
Needs-Triage
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 84/100
PowerShell/PowerShell#28432 · 1 bình luận · 1 reaction ·
Maintainer thường phản hồi trong vòng 1 ngày
-
documentation
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 78/100
microsoft/aspire.dev#2184 ·
Maintainer thường phản hồi trong vòng 2 ngày
-
area-controls-refreshview platform/ios s/triaged
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 74/100
dotnet/maui#40314 · 1 reaction ·
Maintainer thường phản hồi trong vòng 1 ngày