Add rule for tracking all the conventional comments in code like FIXME, TODO, HACK

Đang mở

#2,039 mở ngày 22/10/2024 5 bình luận 0 reaction 0 người được giao Xem trên GitHub

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

Đánh giá

Độ khó: 4/5
Thời gian dự kiến: 3-5 ngày
Mức phù hợp với người mới: 35/100

Loại issue: Tính năng
Độ rõ ràng: Khá rõ ràng
Mức độ hoạt động: Đình trệ
Công nghệ: csharp, powershell
Lĩnh vực: devtools, tooling

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.

Mô tả

Issue - New Rule Issue-Enhancement Up-for-Grabs

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.

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

Mở 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

Add EditorConfig `.editorconfig` to project Đang mở

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 · Mở ngày 11/9/2026
PSUseConsistentIndentation flattens the indentation of commented-out code Đang mở

Độ khó 3/5 1-2 ngày Mức phù hợp với người mới 72/100

PowerShell/PSScriptAnalyzer#2217 · 1 bình luận · Mở ngày 18/9/2026
PSUseConsistentIndentation double-indents attribute bodies that open a scriptblock (`[Attr({ … })]`) Đang mở

Độ khó 3/5 1-2 ngày Mức phù hợp với người mới 70/100

PowerShell/PSScriptAnalyzer#2216 · 2 bình luận · Mở ngày 18/9/2026
`Invoke-Formatter -Range` silently drops corrections after earlier fixes shift text Đang mở

Độ khó 3/5 1-2 ngày Mức phù hợp với người mới 68/100

PowerShell/PSScriptAnalyzer#2211 · Mở ngày 24/8/2026
`PSPlaceOpenBrace` and `PSPlaceCloseBrace` leave trailing whitespace when expanding one-line blocks Đang mở

Độ khó 3/5 1-2 ngày Mức phù hợp với người mới 70/100

PowerShell/PSScriptAnalyzer#2210 · Mở ngày 24/8/2026

Tất cả issue của PowerShell/PSScriptAnalyzer

Issue tương tự

SOCK_FIONREAD/SOCK_FIONBIO/SOCK_FIOASYNC encoded as sizeof(u_long) — the value depends on the host data model Đang mở

Status: Waiting triage Type: Bug

Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 84/100

nanoframework/Home#1857 · Mở ngày 22/9/2026
ResponsiveExtension never reconnects after its host is unloaded and reloaded Đang mở

kind/bug kind/regression

Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 78/100

unoplatform/uno.toolkit.ui#1646 · Mở ngày 22/9/2026
bug(realtime): DataHub failure suppresses Home Assistant glucose relay Đang mở

Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 78/100

nightscout/nocturne#1379 · Mở ngày 22/9/2026
Identity Select with a metadata field emits KEEP _id and drops every document column Đang mở

Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 86/100

elastic/esql-dotnet#47 · Mở ngày 22/9/2026
port: add go-steam fork Đang mở

Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 85/100

SteamRE/SteamKit#1646 · Mở ngày 22/9/2026

Thêm issue về C#