PowerShell / PowerShell/PSScriptAnalyzer

Improve rule suppression documentation

Ouverte
#697 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

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

Description

Existing documentation doesn't provide any information regarding rule-wise behavior of code suppression.

For example, PSSA cannot suppress PSAvoidUsingUserNameAndPassWordParams violations based on given rulesuppressionid.

    Configuration Foo
    {             
     [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSAvoidUsingUserNameAndPassWordParams", "UserName", Scope="Function")]
     [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSAvoidUsingUserNameAndPassWordPara", "EncryptedPassword", Scope="Function")]
        param (
            [Parameter(Mandatory)]
            [String]$UserName,

            [Parameter(Mandatory)]
            [String]$Password
        )

    }

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

L’issue ne nomme aucun fichier de documentation ni aucun test. Commencez par localiser la documentation existante sur la suppression des règles et examiner comment PSSA gère l’exemple montré de SuppressMessageAttribute, notamment les valeurs de rulesuppressionid. Le travail est considéré comme terminé lorsque la documentation explique le comportement de la suppression règle par règle et couvre l’exemple PSavoidUsingUserNameAndPassWordParams.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
powershell
Domaine
documentation
Type d'issue
Documentation
Difficulté
3/5
Temps estimé
1-2 jours
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
45/100

Recevez les nouvelles issues par e-mail

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