Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
IVNSTN opened this issue Oct 22, 2024 · 1 comment

Comments

@IVNSTN
Copy link

IVNSTN commented Oct 22, 2024

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
Copy link

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?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants