Add rule for tracking all the conventional comments in code like FIXME, TODO, HACK
還沒有人認領這個 Issue。
評估
- 難度
- 4/5
- 預估耗時
- 3-5 天
- 新手友好度
- 35/100
研究方向
未指定實作檔案或測試。先找出現有的 PSScriptAnalyzer 規則實作及其測試，然後追蹤分析結果如何匯出至 SonarQube。完成標準是能以所要求的訊息嚴重性偵測 TODO 和 FIXME 等慣用註解，並由測試涵蓋。
由索引模型根據 Issue 內容生成。
描述
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
- 主要語言
- C#
- 星號
- 2.2k
- 分支
- 415
- 平均合併
- 13 小時 1 分鐘
- 30 天內合併 PR
- 2
貢獻指南
從這裡開始
- 先讀完整個 Issue，再讀專案的貢獻指南。
- 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
- Fork 儲存庫，在一個分支上完成修改。
- 送出 Pull Request，並在描述裡引用這個 Issue 編號。
PowerShell/PSScriptAnalyzer 的其他 Issue
-
Up-for-Grabs
難度 1/5 1-3 小時 新手友好度 78/100
PowerShell/PSScriptAnalyzer#2213 · 2 則留言 ·
-
難度 3/5 1-2 天 新手友好度 72/100
PowerShell/PSScriptAnalyzer#2217 · 1 則留言 ·
-
PSUseConsistentIndentation double-indents attribute bodies that open a scriptblock (`[Attr({ … })]`) 未關閉
難度 3/5 1-2 天 新手友好度 70/100
PowerShell/PSScriptAnalyzer#2216 · 2 則留言 ·
-
難度 3/5 1-2 天 新手友好度 68/100
PowerShell/PSScriptAnalyzer#2211 ·
-
`PSPlaceOpenBrace` and `PSPlaceCloseBrace` leave trailing whitespace when expanding one-line blocks 未關閉
難度 3/5 1-2 天 新手友好度 70/100
PowerShell/PSScriptAnalyzer#2210 ·
查看 PowerShell/PSScriptAnalyzer 的全部 Issue
相似的 Issue
-
core dependencies
難度 1/5 1 小時以內 新手友好度 80/100
-
bug frontend good first issue
難度 2/5 1-3 小時 新手友好度 75/100
-
NavigationViewItemAutomationPeer implements IInvokeProvider but never advertises the Invoke pattern 未關閉
難度 2/5 1-3 小時 新手友好度 75/100
unoplatform/uno#24629 ·
-
agentic-workflows Needs: Triage :mag: State: In-PR
難度 2/5 1-3 小時 新手友好度 70/100
-
Down / Waiting for removal
難度 2/5 1-3 小時 新手友好度 70/100