PowerShell / PowerShell/PSScriptAnalyzer

Improve rule suppression documentation

Aberta
#697 0 comentários 0 reações 0 responsáveis Ver no GitHub

Ninguém assumiu esta issue ainda.

Area - Documentation Issue - Enhancement
Linguagem predominante
C#
Estrelas
2.2k
Forks
414
Merge médio
13h 1min
PRs com merge (30d)
2

Descrição

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
        )

    }

Guia de contribuição

Abrir o guia de contribuição

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Direção de pesquisa

A issue não menciona nenhum arquivo de documentação nem teste. Comece localizando a documentação existente sobre supressão de regras e revisando como o PSSA lida com o exemplo mostrado de SuppressMessageAttribute, incluindo os valores de rulesuppressionid. O trabalho estará concluído quando a documentação explicar o comportamento da supressão por regra e abranger o exemplo PSavoidUsingUserNameAndPassWordParams.

Escrita pelo modelo de indexação a partir do texto da issue.

Avaliação

Stack de tecnologia
powershell
Domínio
documentation
Tipo de issue
Documentação
Dificuldade
3/5
Tempo estimado
1-2 dias
Status de atividade
Estagnada
Clareza
Razoavelmente clara
Facilidade para iniciantes
45/100

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.