PowerShell / PowerShell/PSScriptAnalyzer
Add rule for tracking all the conventional comments in code like FIXME, TODO, HACK
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ả
Summary of the new feature
I'd like to see notifications/warnings/info messages about conventional comments detected in code, e.g.
# FIXME : something that does not work properly in some conditions
# TODO - unfinished work
# HACK bad place, dirty trick
Also we export code analysis results to SonarQube and since there is no such rule, I cant see all the technical debt mentioned in the whole codebase.
Proposed technical implementation details (optional)
A rule needs to be created. TODO comments should have info/hint status, FIXME and others may have warning status.
Here is what I see in SonarQube for C# repo
I'd like to have the same information for Powershell repo.
Related links
- CWE Suspicious comments
- Docs on sonar scanner for .net rules: fixme, todo
What is the latest version of PSScriptAnalyzer at the point of writing
1.23.0
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
Không có tệp triển khai hoặc bài kiểm thử nào được nêu tên. Hãy bắt đầu bằng cách tìm các triển khai quy tắc PSScriptAnalyzer hiện có và các bài kiểm thử của chúng, sau đó theo dõi cách kết quả phân tích được xuất sang SonarQube. Hoàn thành khi các chú thích thông thường như TODO và FIXME được phát hiện với các mức độ nghiêm trọng của thông báo được yêu cầu và được bao phủ bởi các bài kiểm thử.
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, 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