Fix issue #338 and issue #339

Author: johlju

CHANGELOG.md

@@ -56,6 +56,7 @@
   to the relevant DSC resource GitHub Wiki ([issue #142](https://github.com/PowerShell/DscResource.Tests/issues/142)).
 - Update New-DscResourcePowerShellHelp to optionally output the PowerShell help files to
   the resource specific path and fix the example processing.
+  - The files are now outputted as UTF-8 (ASCII).
 - Added processing to `Test-PublishMetaData` for the InvalidGUID error from Test-ScriptFileInfo
   ([issue #330](https://github.com/PowerShell/DscResource.Tests/issues/330)).
 

DscResource.DocumentationHelper/PowerShellHelp.psm1

@@ -24,44 +24,43 @@ $moduleName = $ExecutionContext.SessionState.Module
 $script:localizedData = Get-LocalizedData -ModuleName $moduleName -ModuleRoot $PSScriptRoot
 
 <#
-.SYNOPSIS
-New-DscResourcePowerShellHelp generates PowerShell compatible help files for a DSC
-resource module
-
-.DESCRIPTION
-The New-DscResourcePowerShellHelp cmdlet will review all of the MOF based resources
-in a specified module directory and will inject PowerShell help files for each resource.
-These help files include details on the property types for each resource, as well as a text
-description and examples where they exist.
+    .SYNOPSIS
+        New-DscResourcePowerShellHelp generates PowerShell compatible help files for a DSC
+        resource module
 
-The help files are output to the OutputPath directory if specified, or if not, they are
-output to the releveant resource's 'en-US' directory.
+    .DESCRIPTION
+        The New-DscResourcePowerShellHelp cmdlet will review all of the MOF based resources
+        in a specified module directory and will inject PowerShell help files for each resource.
+        These help files include details on the property types for each resource, as well as a text
+        description and examples where they exist.
 
-A README.md with a text description must exist in the resource's subdirectory for the
-help file to be generated.
+        The help files are output to the OutputPath directory if specified, or if not, they are
+        output to the releveant resource's 'en-US' directory.
 
-These help files can then be read by passing the name of the resource as a parameter to Get-Help.
+        A README.md with a text description must exist in the resource's subdirectory for the
+        help file to be generated.
 
-.PARAMETER ModulePath
-The path to the root of the DSC resource module (where the PSD1 file is found, not the folder for
-each individual DSC resource)
+        These help files can then be read by passing the name of the resource as a parameter to Get-Help.
 
-.EXAMPLE
-This example shows how to generate help for a specific module
+    .PARAMETER ModulePath
+        The path to the root of the DSC resource module (where the PSD1 file is found, not the folder for
+        each individual DSC resource)
 
-    New-DscResourcePowerShellHelp -ModulePath C:\repos\SharePointdsc
+    .EXAMPLE
+        This example shows how to generate help for a specific module
 
+        New-DscResourcePowerShellHelp -ModulePath C:\repos\SharePointdsc
 #>
 function New-DscResourcePowerShellHelp
 {
     [CmdletBinding()]
     param
     (
-        [parameter(Mandatory = $true)]
+        [Parameter(Mandatory = $true)]
         [System.String]
         $ModulePath,
 
-        [parameter()]
+        [Parameter()]
         [System.String]
         $OutputPath
     )
@@ -70,14 +69,17 @@ function New-DscResourcePowerShellHelp
 
     $mofSearchPath = (Join-Path -Path $ModulePath -ChildPath '\**\*.schema.mof')
     $mofSchemas = Get-ChildItem -Path $mofSearchPath -Recurse
+
     Write-Verbose -Message ($script:localizedData.FoundMofFilesMessage -f $mofSchemas.Count, $ModulePath)
+
     $mofSchemas | ForEach-Object {
         $mofFileObject = $_
 
         $result = (Get-MofSchemaObject -FileName $_.FullName) | Where-Object -FilterScript {
             ($_.ClassName -eq $mofFileObject.Name.Replace('.schema.mof', '')) `
                 -and ($null -ne $_.FriendlyName)
         }
+
         $descriptionPath = Join-Path -Path $mofFileObject.DirectoryName -ChildPath 'readme.md'
 
         if (Test-Path -Path $descriptionPath)
@@ -89,8 +91,11 @@ function New-DscResourcePowerShellHelp
             $output += [Environment]::NewLine + [Environment]::NewLine
 
             $descriptionContent = Get-Content -Path $descriptionPath -Raw
-            $descriptionContent = $descriptionContent -replace "\n", "`n    "
-            $descriptionContent = $descriptionContent -replace "# Description\r\n    ", ".DESCRIPTION"
+
+            $descriptionContent = $descriptionContent -replace '\n', "`n    "
+            $descriptionContent = $descriptionContent -replace '# Description\r\n    ', '.DESCRIPTION'
+            $descriptionContent = $descriptionContent -replace '\r\n\s{4}\r\n', "`n`n"
+            $descriptionContent = $descriptionContent -replace '\s{4}$', ''
 
             $output += $descriptionContent
             $output += [Environment]::NewLine
@@ -150,8 +155,10 @@ function New-DscResourcePowerShellHelp
             {
                 $savePath = Join-Path -Path $mofFileObject.DirectoryName -ChildPath 'en-US' | Join-Path -ChildPath $outputFileName
             }
+
             Write-Verbose -Message ($script:localizedData.OutputHelpDocumentMessage -f $savePath)
-            $output | Out-File -FilePath $savePath -Encoding utf8 -Force
+
+            $output | Out-File -FilePath $savePath -Encoding ascii -Force
         }
         else
         {