Fixed encoding bug in the ScriptGenerator

Also added Encoding parmeter to ConvertTo-Script

Author: Jaykul

Source/Private/SetModuleContent.ps1

@@ -1,7 +1,7 @@
 function SetModuleContent {
     <#
         .SYNOPSIS
-            A wrapper for Set-Content that handles arrays of file paths
+            A wrapper for Set-Content that copies lists of files
         .DESCRIPTION
             The implementation here is strongly dependent on Build-Module doing the right thing
             Build-Module can optionally pass a PREFIX or SUFFIX, but otherwise only passes files
@@ -15,7 +15,7 @@ function SetModuleContent {
     [CmdletBinding()]
     param(
         # Where to write the joined output
-        [Parameter(Position=0, Mandatory)]
+        [Parameter(Position = 0, Mandatory)]
         [string]$OutputPath,
 
         # Input files, the scripts that will be copied to the output path
@@ -28,7 +28,7 @@ function SetModuleContent {
         # The working directory (allows relative paths for other values)
         [string]$WorkingDirectory = $pwd,
 
-        # The encoding defaults to UTF8 (or UTF8NoBom on Core)
+        # The encoding defaults to UTF8 (or UTF8Bom on Core)
         [Parameter(DontShow)]
         [string]$Encoding = $(if($IsCoreCLR) { "UTF8Bom" } else { "UTF8" })
     )

Source/Public/Build-Module.ps1

@@ -306,7 +306,7 @@ function Build-Module {
                 Join-Path -Path $ModuleInfo.ModuleBase -ChildPath $_ | Convert-Path -ErrorAction SilentlyContinue
             }
 
-            $ModuleInfo.Generators | Invoke-ScriptGenerator -Path $RootModule -Overwrite
+            $ModuleInfo.Generators | Invoke-ScriptGenerator -Path $RootModule -Overwrite -Encoding $ModuleInfo.Encoding
 
 
             # This is mostly for testing ...

Source/Public/ConvertTo-Script.ps1

@@ -53,7 +53,12 @@ function ConvertTo-Script {
         # This is used to find the module manifest,
         # But the the script will be saved in the same location
         [Parameter(Mandatory, ValueFromPipelineByPropertyName)]
-        [string]$Path
+        [string]$Path,
+
+        # File encoding for output RootModule (defaults to UTF8)
+        # Converted to System.Text.Encoding for PowerShell 6 (and something else for PowerShell 5)
+        [ValidateSet("UTF8", "UTF8Bom", "UTF8NoBom", "UTF7", "ASCII", "Unicode", "UTF32")]
+        [string]$Encoding = $(if ($IsCoreCLR) { "UTF8Bom" } else { "UTF8" })
     )
     begin {
         Write-Debug "    ENTER: ConvertTo-Script BEGIN $Path $FunctionName"
@@ -81,6 +86,8 @@ function ConvertTo-Script {
                 return [AstVisitAction]::Continue
             }
         }
+
+        $SetContentCmd = $ExecutionContext.InvokeCommand.GetCommand('Microsoft.PowerShell.Management\Set-Content', [System.Management.Automation.CommandTypes]::Cmdlet)
         Write-Debug "    EXIT: ConvertTo-Script BEGIN"
     }
     process {
@@ -131,7 +138,7 @@ function ConvertTo-Script {
                 Get-Item $Path
             ) | CompressToBase64 -ExpandScriptName ImportBase64Module
             "$FunctionName @PSBoundParameters"
-        ) | Set-Content "$FunctionName.ps1"
+        ) | & $SetContentCmd -Path "$FunctionName.ps1" -Encoding $Encoding
 
         Update-ScriptFileInfo "$FunctionName.ps1" -Version $Manifest.ModuleVersion -Author $Manifest.Author -CompanyName $Manifest.CompanyName -Copyright $Manifest.Copyright -Tags $Manifest.PrivateData.PSData.Tags -ProjectUri $Manifest.PrivateData.PSData.ProjectUri -LicenseUri $Manifest.PrivateData.PSData.LicenseUri -IconUri $Manifest.PrivateData.PSData.IconUri -ReleaseNotes $Manifest.PrivateData.PSData.ReleaseNotes
 

Source/Public/Invoke-ScriptGenerator.ps1

@@ -68,7 +68,11 @@ function Invoke-ScriptGenerator {
 
         # If set, will overwrite the Source with the generated content.
         # Use with care, as this will modify the source file!
-        [switch]$Overwrite
+        [switch]$Overwrite,
+
+        # The encoding defaults to UTF8 (or UTF8Bom on Core)
+        [Parameter(DontShow)]
+        [string]$Encoding = $(if($IsCoreCLR) { "UTF8Bom" } else { "UTF8" })
     )
     begin {
         $AstParam = @{} + $PSBoundParameters
@@ -77,6 +81,7 @@ function Invoke-ScriptGenerator {
         $null = $AstParam.Remove("Parameters")
         $ParseResults = ConvertToAst @AstParam
         [StringBuilder]$Builder = $ParseResults.Ast.Extent.Text
+        $SetContentCmd = $ExecutionContext.InvokeCommand.GetCommand('Microsoft.PowerShell.Management\Set-Content', [System.Management.Automation.CommandTypes]::Cmdlet)
     }
     process {
         if (-not $PSBoundParameters.ContainsKey("Generator") -and $Parameters.ContainsKey("Generator")) {
@@ -115,10 +120,10 @@ function Invoke-ScriptGenerator {
 
         # Find that generator...
         $GeneratorCmd = Get-Command -Name ${Generator} -ParameterType Ast -ErrorAction Ignore <# -CommandType Function #> |
-            Where-Object {
-                $_.OutputType.Name -eq "TextReplacement" -or ($_.CommandType -eq "Alias" -and $_.Definition -like "PesterMock*" )
-            } |
-            Select-Object -First 1
+        Where-Object {
+            $_.OutputType.Name -eq "TextReplacement" -or ($_.CommandType -eq "Alias" -and $_.Definition -like "PesterMock*" )
+        } |
+        Select-Object -First 1
 
         if (-not $GeneratorCmd) {
             Write-Error "Generator missconfiguration. Unable to find Generator = '$Generator'"
@@ -137,14 +142,14 @@ function Invoke-ScriptGenerator {
             $ParseResults = ConvertToAst -Code $Builder.ToString() -Path $ParseResults.Path
             # In case a Generator tries to use the actual files, update the content
             if ($Overwrite -and $ParseResults.Path -and $ParseResults.Path -ne "scriptblock") {
-                Set-Content $ParseResults.Path $Builder
+                & $SetContentCmd -Path $ParseResults.Path -Value $Builder -Encoding $Encoding
             }
         }
     }
     end {
         Write-Debug "Overwrite: $Overwrite and it's a file: $(([bool]$ParseResults.Path) -and $ParseResults.Path -ne "scriptblock") (Content is $($Builder.Length) long)"
         if ($Overwrite -and $ParseResults.Path -and $ParseResults.Path -ne "scriptblock") {
-            Set-Content $ParseResults.Path $Builder
+            & $SetContentCmd -Path $ParseResults.Path -Value $Builder -Encoding $Encoding
         } else {
             $Builder.ToString()
         }