PowerShell / PowerShell/PSScriptAnalyzer

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

Aberta
#2,039 5 comentários 0 reações 0 responsáveis Ver no GitHub

Ninguém assumiu esta issue ainda.

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

Descrição

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

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

Nenhum arquivo de implementação ou teste é especificado. Comece localizando as implementações de regras existentes do PSScriptAnalyzer e seus testes e, em seguida, rastreie como os resultados da análise são exportados para o SonarQube. A tarefa estará concluída quando comentários convencionais, como TODO e FIXME, forem detectados com as severidades de mensagem solicitadas e cobertos por testes.

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

Avaliação

Stack de tecnologia
csharp, powershell
Domínio
devtools, tooling
Tipo de issue
Funcionalidade
Dificuldade
4/5
Tempo estimado
3-5 dias
Status de atividade
Estagnada
Clareza
Razoavelmente clara
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.