psake / psake/PowerShellBuild

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

Ouverte Adaptée aux débutants
#211 1 commentaire 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

bug
Langage dominant
PowerShell
Étoiles
145
Forks
27
Merge moyen
10 h 16 min
PR mergées (30 j)
34

Description

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.

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Commencez par la logique de staging de Build-PSBuildModule décrite dans l’issue et examinez les issues associées #206, #207 et #210 avant de modifier le comportement de depth. Vérifiez que le manifeste racine et les fichiers de module sont toujours correctement placés en staging, tandis qu’un fichier localisé en-US/Messages.psd1 n’est pas copié dans la racine de sortie.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
powershell
Domaine
build-system
Type d'issue
Bug
Difficulté
2/5
Temps estimé
1-3 heures
Activité
Active
Clarté
Plutôt claire
Accessibilité débutants
74/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.