psake / psake/PowerShellBuild

Staging flattens a culture directory's .psd1 into the output root

Abierto Apto para principiantes
#211 1 comentario 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

bug
Lenguaje dominante
PowerShell
Estrellas
145
Forks
27
Merge medio
10 h 16 min
PR fusionados (30 d)
34

Descripción

Found while researching #207. Reading the code confirms it; it is also visible in that issue's own reproduction output.

What happens

Build-PSBuildModule stages the module's loose files with:

$getChildItemSplat = @{
    Path    = $Path
    Include = "*.psm1", "*.psd1", "*.ps1xml"
    Depth   = 1
}
Get-ChildItem @getChildItemSplat |
    Copy-Item -Destination $DestinationPath -Force

-Depth 1 implies recursion one level down, so this matches en-US/Messages.psd1 — and Copy-Item -Destination $DestinationPath writes it flat into the output root, discarding the directory it came from.

A module with a localized Messages.psd1 therefore builds an output containing a stray Messages.psd1 at the root that nothing reads. If CopyDirectories also names en-US, the correct copy is there too, and the built tree carries both.

Why it matters, mildly

Nothing breaks. Import-LocalizedData resolves through the culture directory and ignores the stray file, and a module without a culture directory never hits it. The costs are that the published package carries a file that serves no purpose and misleads anyone reading the tree, and that a consumer debugging localization finds two copies of the same file and has to work out which one is live.

It is also the same root cause as #210, seen from the other side: the depth-1 glob is trying to serve two purposes — collect the root manifest and module file, and leave everything else to CopyDirectories — and reaches one level too far.

Options

  1. Drop -Depth 1, so the glob matches only the root. The manifest and root module are always at the root, so nothing intended is lost. Anything deeper is CopyDirectories' job. Smallest change.
  2. Preserve relative paths when copying, so en-US/Messages.psd1 lands at en-US/Messages.psd1. More faithful, and it would partly address #210 — but it makes the glob a second, implicit staging mechanism competing with CopyDirectories, which is how the two got tangled in the first place.
  3. Leave it. The stray file is inert.

(1) looks right, and it is a one-word deletion. But -Depth 1 was presumably added deliberately at some point, and I could not find what for — worth a moment's thought before removing it, in case some layout depends on it.

Related: #206, #207 and #210 are all in this same staging logic. Worth deciding together.

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Línea de trabajo

Comienza por la lógica de staging de Build-PSBuildModule descrita en el issue y revisa los issues relacionados #206, #207 y #210 antes de cambiar el comportamiento de depth. Verifica que el manifiesto raíz y los archivos de módulo se sigan preparando correctamente, mientras que un archivo localizado en en-US/Messages.psd1 no se copie en la raíz de salida.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
powershell
Área
build-system
Tipo de issue
Error
Dificultad
2/5
Tiempo estimado
1-3 horas
Estado de actividad
Activo
Claridad
Bastante claro
Aptitud para principiantes
74/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.