PowerShell / PowerShell/PSScriptAnalyzer
Rule Proposal: Warn on dot-sourced function
Ninguém assumiu esta issue ainda.
- Linguagem predominante
- C#
- Estrelas
- 2.2k
- Forks
- 414
- Merge médio
- 13h 1min
- PRs com merge (30d)
- 2
Descrição
I've inherited a project where everything is in, for lack of a better description, undeclared global scope, spread across several files. Functions don't have always have parameters, and are called with a dot before the function name. Variables are treated as global, though not declared. For example:
c:\Utils.ps1
function Write-MyLog {
$itemToLog | out-file c:\mylog.txt -append
}
c:\Interface.ps1
. c:\Utils.ps1
$itemToLog = "Something happened"
. Write-MyLog
Miraculously, this all works. Of course, I dare not change anything.
I would love it if ". Write-MyLog" came up as a warning, and even more so if there were some indication that "$itemToLog" in C:\Interface.ps1 was being used by the function called from c:\Utils.ps1.
Guia de contribuição
Primeiros passos
- Leia a issue inteira e depois o guia de contribuição do projeto.
- Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
- Faça um fork do repositório e trabalhe em uma branch.
- Abra um pull request que referencie o número da issue.
Direção de pesquisa
Comece reproduzindo o comportamento nos scripts de exemplo c:\Utils.ps1 e c:\Interface.ps1, concentrando-se na chamada de função dot-sourced e na variável $itemToLog entre arquivos. Considera-se concluído quando o analisador emitir um aviso sobre a construção solicitada e fornecer a indicação solicitada do uso da variável, com o escopo e os diagnósticos esperados acordados.
Escrita pelo modelo de indexação a partir do texto da issue.
Avaliação
- Stack de tecnologia
- powershell
- Domínio
- tooling
- Tipo de issue
- Funcionalidade
- Dificuldade
- 5/5
- Tempo estimado
- Mais de uma semana
- Status de atividade
- Estagnada
- Clareza
- Razoavelmente clara
- Facilidade para iniciantes
- 25/100