PowerShell / PowerShell/PSScriptAnalyzer

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

Ouverte
#2,039 5 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Issue - New Rule Issue-Enhancement Up-for-Grabs
Langage dominant
C#
Étoiles
2.2k
Forks
414
Merge moyen
13 h 1 min
PR mergées (30 j)
2

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

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

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.

Évaluation

Stack technique
csharp, powershell
Domaine
devtools, tooling
Type d'issue
Fonctionnalité
Difficulté
4/5
Temps estimé
3-5 jours
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
35/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.