Use a BOM by default for Windows PowerShell's sake

Merge pull request #86 from PoshCode/feature/Utf8Bom
+semver:fix

Author: Jaykul

Source/Private/SetModuleContent.ps1

@@ -28,7 +28,7 @@ function SetModuleContent {
 
         # The encoding defaults to UTF8 (or UTF8NoBom on Core)
         [Parameter(DontShow)]
-        [string]$Encoding = $(if($IsCoreCLR) { "UTF8NoBom" } else { "UTF8" })
+        [string]$Encoding = $(if($IsCoreCLR) { "UTF8Bom" } else { "UTF8" })
     )
     begin {
         Push-Location $WorkingDirectory -StackName SetModuleContent
@@ -64,4 +64,4 @@ function SetModuleContent {
         $SetContent.End()
         Pop-Location -StackName SetModuleContent
     }
-}
+}

Source/Public/Build-Module.ps1

@@ -110,8 +110,8 @@ function Build-Module {
 
         # File encoding for output RootModule (defaults to UTF8)
         # Converted to System.Text.Encoding for PowerShell 6 (and something else for PowerShell 5)
-        [ValidateSet("UTF8","UTF7","ASCII","Unicode","UTF32")]
-        [string]$Encoding = "UTF8",
+        [ValidateSet("UTF8", "UTF8Bom", "UTF8NoBom", "UTF7", "ASCII", "Unicode", "UTF32")]
+        [string]$Encoding = $(if($IsCoreCLR) { "UTF8Bom" } else { "UTF8" }),
 
         # The prefix is either the path to a file (relative to the module folder) or text to put at the top of the file.
         # If the value of prefix resolves to a file, that file will be read in, otherwise, the value will be used.
@@ -133,8 +133,8 @@ function Build-Module {
     )
 
     begin {
-        if ($Encoding -ne "UTF8") {
-            Write-Warning "We strongly recommend you build your script modules with UTF8 encoding for maximum cross-platform compatibility."
+        if ($Encoding -notmatch "UTF8") {
+            Write-Warning "For maximum portability, we strongly recommend you build your script modules with UTF8 encoding (with a BOM, for backwards compatibility to PowerShell 5)."
         }
     }
     process {

Tests/Integration/Source1/Public/Set-Source.ps1

@@ -1,5 +1,6 @@
-function Set-Source {
+function Set-Source {
     [CmdletBinding()]
     [Alias("ss", "ssou")]
     param()
+    "sto͞o′pĭd"
 }