PowerShell / PowerShell/PSScriptAnalyzer

PSAvoidUsingCmdletAliases triggers on GherkinStep

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

Ninguém assumiu esta issue ainda.

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

Descrição

Gherkin (including in Pester) has a few aliases which you are meant to use when creating steps.

Alias           And -> GherkinStep                                 4.2.0      Pester
Alias           But -> GherkinStep                                 4.2.0      Pester
Alias           Given -> GherkinStep                               4.2.0      Pester
Alias           Then -> GherkinStep                                4.2.0      Pester
Alias           When -> GherkinStep                                4.2.0      Pester

These are valid uses of the alias and shouldn't trigger analyzer warnings.

Steps to reproduce

Create a Gherkin (Pester) step file like Blah.Steps.ps1

Given "something" {
}

Then Invoke-ScriptAnalyzer Blah.Steps.ps1

Expected behavior

No issues.

Actual behavior

RuleName                            Severity     ScriptName Line  Message
--------                            --------     ---------- ----  -------
PSAvoidUsingCmdletAliases           Warning      Blah.Steps 1     'Given' is an alias of 'GherkinStep'. Alias can introduce
                                                 .ps1             possible problems and make scripts hard to maintain. Please
                                                                  consider changing alias to its full content.

Environment data

Name                           Value
----                           -----
PSVersion                      5.1.14393.1944
PSEdition                      Desktop
PSCompatibleVersions           {1.0, 2.0, 3.0, 4.0...}
BuildVersion                   10.0.14393.1944
CLRVersion                     4.0.30319.42000
WSManStackVersion              3.0
PSRemotingProtocolVersion      2.3
SerializationVersion           1.1.0.1

1.16.1

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

Reproduza o aviso com o exemplo Blah.Steps.ps1 executando Invoke-ScriptAnalyzer, com foco em PSAvoidUsingCmdletAliases e nos aliases GherkinStep. Considera-se concluído quando Given, And, But, When e Then usados como etapas Gherkin do Pester não produzirem problemas do analisador, enquanto os aliases comuns continuarem cobertos pela regra.

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

Avaliação

Stack de tecnologia
csharp, powershell
Domínio
tooling
Tipo de issue
Bug
Dificuldade
3/5
Tempo estimado
1-2 dias
Status de atividade
Estagnada
Clareza
Claramente especificada
Facilidade para iniciantes
35/100

Receba novas issues na sua caixa de entrada

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