PowerShell / PowerShell/PSScriptAnalyzer
Rule Proposal: Warn on dot-sourced function
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- C#
- Estrellas
- 2.2k
- Forks
- 414
- Merge medio
- 13 h 1 min
- PR fusionados (30 d)
- 2
Descripción
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.
Guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Línea de trabajo
Comienza reproduciendo el comportamiento de los scripts de ejemplo c:\Utils.ps1 y c:\Interface.ps1, centrándote en la llamada a la función dot-sourced y en la variable $itemToLog entre archivos. Se considera completado cuando el analizador advierte sobre la construcción solicitada y proporciona la indicación solicitada del uso de la variable, con el ámbito y los diagnósticos esperados acordados.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- powershell
- Área
- tooling
- Tipo de issue
- Nueva funcionalidad
- Dificultad
- 5/5
- Tiempo estimado
- Más de una semana
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 25/100