PowerShell / PowerShell/PSScriptAnalyzer

Rule request: Avoid enclosing strings with smart quotes

Aberta
#1,936 4 comentários 0 reações 0 responsáveis Ver no GitHub

Ninguém assumiu esta issue ainda.

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

Descrição

Background (excerpt from Wikipedea Quotation mark definition):

Regarding their appearance, there are two types of quotation marks:

  • '…' and "…" are known as neutral, vertical, straight, typewriter, dumb, or ASCII quotation marks. The left and right marks are identical. These are found on typical English typewriters and computer keyboards, although they are sometimes automatically converted to the other type by software.
  • ‘…’ and “…” are known as typographic, curly, curved, book, or smart quotation marks...

Summary of the new feature

Quoted strings are sometimes unintendedly replaced when passed by word processors as Microsoft Office applications as MSWord and Outlook. It is recommended to surround strings with unambiguous single quoted or double quoted string as it unnecessary triggers the UseBOMForUnicodeEncodedFile rule with no clear indication of the location.

Proposed technical implementation details (optional)

See (PowerShell based) prototype AvoidSmartQuotedString at: https://github.com/iRon7/PSRules

What is the latest version of PSScriptAnalyzer at the point of writing

1.21.0

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

Comece lendo o protótipo AvoidSmartQuotedString no PSRules e a documentação existente da regra UseBOMForUnicodeEncodedFile no PSScriptAnalyzer. Determine como uma nova regra de análise é estruturada e testada e, em seguida, defina a conclusão como a detecção de strings com aspas tipográficas não intencionais sem produzir um aviso BOM enganoso.

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
Funcionalidade
Dificuldade
4/5
Tempo estimado
3-5 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.