PowerShell / PSScriptAnalyzer

Download ScriptAnalyzer from PowerShellGallery
https://www.powershellgallery.com/packages/PSScriptAnalyzer/
MIT License
1.87k stars 378 forks source link

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

Open IVNSTN opened 1 month ago

IVNSTN commented 1 month ago

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 image I'd like to have the same information for Powershell repo.

Related links

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

1.23.0

HeyItsGilbert commented 1 month ago

What level would it make sense to make this alert? I feel like Warning might be too high. Been working on something similar for my team since we use TODO Tree to highlight these in vscode.

@SydneyhSmith does the up-for-grabs tag indicate that you're open to contributors?