Add rule for tracking all the conventional comments in code like FIXME, TODO, HACK
Personne n'a encore pris cette issue.
Évaluation
- Difficulté
- 4/5
- Temps estimé
- 3-5 jours
- Accessibilité débutants
- 35/100
Piste de recherche
Aucun fichier d’implémentation ni test n’est nommé. Commencez par localiser les implémentations de règles PSScriptAnalyzer existantes et leurs tests, puis retracez la façon dont les résultats de l’analyse sont exportés vers SonarQube. La tâche est terminée lorsque les commentaires conventionnels tels que TODO et FIXME sont détectés avec les niveaux de gravité de message demandés et couverts par des tests.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Description
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
- Langage dominant
- C#
- Étoiles
- 2.2k
- Forks
- 415
- Merge moyen
- 13 h 1 min
- PR mergées (30 j)
- 2
Guide de contribution
Ouvrir le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Autres issues de PowerShell/PSScriptAnalyzer
-
Up-for-Grabs
Difficulté 1/5 1-3 heures Accessibilité débutants 78/100
PowerShell/PSScriptAnalyzer#2213 · 2 commentaires ·
-
Difficulté 3/5 1-2 jours Accessibilité débutants 72/100
PowerShell/PSScriptAnalyzer#2217 · 1 commentaire ·
-
PSUseConsistentIndentation double-indents attribute bodies that open a scriptblock (`[Attr({ … })]`) Ouverte
Difficulté 3/5 1-2 jours Accessibilité débutants 70/100
PowerShell/PSScriptAnalyzer#2216 · 2 commentaires ·
-
Difficulté 3/5 1-2 jours Accessibilité débutants 68/100
PowerShell/PSScriptAnalyzer#2211 ·
-
`PSPlaceOpenBrace` and `PSPlaceCloseBrace` leave trailing whitespace when expanding one-line blocks Ouverte
Difficulté 3/5 1-2 jours Accessibilité débutants 70/100
PowerShell/PSScriptAnalyzer#2210 ·
Toutes les issues de PowerShell/PSScriptAnalyzer
Issues similaires
-
bug
Difficulté 2/5 1-3 heures Accessibilité débutants 75/100
nightscout/nocturne#1425 ·
-
【Bug】dotnet版本多行输出解析不兼容(含AI解决办法) Ouverte
Difficulté 2/5 1-3 heures Accessibilité débutants 70/100
RayWangQvQ/BiliBiliToolPro#1137 ·
-
Difficulté 2/5 1-3 heures Accessibilité débutants 65/100
-
Difficulté 2/5 1-3 heures Accessibilité débutants 75/100
-
Difficulté 2/5 1-3 heures Accessibilité débutants 70/100