DscResource.DocGenerator.psm1
|
#Region './prefix.ps1' 0 # This is added to the top of the generated file module file. $script:resourceHelperModulePath = Join-Path -Path $PSScriptRoot -ChildPath '.\Modules\DscResource.Common' Import-Module -Name $script:resourceHelperModulePath $script:localizedData = Get-LocalizedData -DefaultUICulture 'en-US' <# Define enumeration for use by help example generation to determine the type of block that a text line is within. #> if (-not ([System.Management.Automation.PSTypeName]'HelpExampleBlockType').Type) { $typeDefinition = @' public enum HelpExampleBlockType { None, PSScriptInfo, Configuration, ExampleCommentHeader } '@ Add-Type -TypeDefinition $typeDefinition } <# Define enumeration for use by wiki example generation to determine the type of block that a text line is within. #> if (-not ([System.Management.Automation.PSTypeName]'WikiExampleBlockType').Type) { $typeDefinition = @' public enum WikiExampleBlockType { None, PSScriptInfo, Configuration, ExampleCommentHeader } '@ Add-Type -TypeDefinition $typeDefinition } #EndRegion './prefix.ps1' 43 #Region './Private/Get-DscResourceHelpExampleContent.ps1' 0 <# .SYNOPSIS This function reads an example file from a resource and converts it to help text for inclusion in a PowerShell help file. .DESCRIPTION The function will read the example PS1 file and convert the help header into the description text for the example. .PARAMETER ExamplePath The path to the example file. .PARAMETER ModulePath The number of the example. .EXAMPLE Get-DscResourceHelpExampleContent -ExamplePath 'C:\repos\NetworkingDsc\Examples\Resources\DhcpClient\1-DhcpClient_EnableDHCP.ps1' -ExampleNumber 1 Reads the content of 'C:\repos\NetworkingDsc\Examples\Resources\DhcpClient\1-DhcpClient_EnableDHCP.ps1' and converts it to help text in preparation for being added to a PowerShell help file. #> function Get-DscResourceHelpExampleContent { [CmdletBinding()] [OutputType([System.String])] param ( [Parameter(Mandatory = $true)] [System.String] $ExamplePath, [Parameter(Mandatory = $true)] [System.Int32] $ExampleNumber ) $exampleContent = Get-Content -Path $ExamplePath # Use a string builder to assemble the example description and code $exampleDescriptionStringBuilder = New-Object -TypeName System.Text.StringBuilder $exampleCodeStringBuilder = New-Object -TypeName System.Text.StringBuilder <# Step through each line in the source example and determine the content and act accordingly: \<#PSScriptInfo...#\> - Drop block \#Requires - Drop Line \<#...#\> - Drop .EXAMPLE, .SYNOPSIS and .DESCRIPTION but include all other lines Configuration ... - Include entire block until EOF #> $blockType = [HelpExampleBlockType]::None foreach ($exampleLine in $exampleContent) { Write-Debug -Message ('Processing Line: {0}' -f $exampleLine) # Determine the behavior based on the current block type switch ($blockType.ToString()) { 'PSScriptInfo' { Write-Debug -Message 'PSScriptInfo Block Processing' # Exclude PSScriptInfo block from any output if ($exampleLine -eq '#>') { Write-Debug -Message 'PSScriptInfo Block Ended' # End of the PSScriptInfo block $blockType = [HelpExampleBlockType]::None } } 'Configuration' { Write-Debug -Message 'Configuration Block Processing' # Include all lines in the configuration block in the code output $null = $exampleCodeStringBuilder.AppendLine($exampleLine) } 'ExampleCommentHeader' { Write-Debug -Message 'ExampleCommentHeader Block Processing' # Include all lines in Example Comment Header block except for headers $exampleLine = $exampleLine.TrimStart() if ($exampleLine -notin ('.SYNOPSIS', '.DESCRIPTION', '.EXAMPLE', '#>')) { # Not a header so add this to the output $null = $exampleDescriptionStringBuilder.AppendLine($exampleLine) } if ($exampleLine -eq '#>') { Write-Debug -Message 'ExampleCommentHeader Block Ended' # End of the Example Comment Header block $blockType = [HelpExampleBlockType]::None } } default { Write-Debug -Message 'Not Currently Processing Block' # Check the current line if ($exampleLine.TrimStart() -eq '<#PSScriptInfo') { Write-Debug -Message 'PSScriptInfo Block Started' $blockType = [HelpExampleBlockType]::PSScriptInfo } elseif ($exampleLine -match 'Configuration') { Write-Debug -Message 'Configuration Block Started' $null = $exampleCodeStringBuilder.AppendLine($exampleLine) $blockType = [HelpExampleBlockType]::Configuration } elseif ($exampleLine.TrimStart() -eq '<#') { Write-Debug -Message 'ExampleCommentHeader Block Started' $blockType = [HelpExampleBlockType]::ExampleCommentHeader } } } } # Assemble the final output $null = $exampleStringBuilder = New-Object -TypeName System.Text.StringBuilder $null = $exampleStringBuilder.AppendLine(".EXAMPLE $ExampleNumber") $null = $exampleStringBuilder.AppendLine() $null = $exampleStringBuilder.AppendLine($exampleDescriptionStringBuilder) $null = $exampleStringBuilder.Append($exampleCodeStringBuilder) # ALways return CRLF as line endings to work cross platform. return ($exampleStringBuilder.ToString() -replace '\r?\n', "`r`n") } #EndRegion './Private/Get-DscResourceHelpExampleContent.ps1' 141 #Region './Private/Get-DscResourceWikiExampleContent.ps1' 0 <# .SYNOPSIS This function reads an example file from a resource and converts it to markdown for inclusion in a resource wiki file. .DESCRIPTION The function will read the example PS1 file and convert the help header into the description text for the example. It will also surround the example configuration with code marks to indication it is powershell code. .PARAMETER ExamplePath The path to the example file. .PARAMETER ModulePath The number of the example. .EXAMPLE Get-DscResourceWikiExampleContent -ExamplePath 'C:\repos\NetworkingDsc\Examples\Resources\DhcpClient\1-DhcpClient_EnableDHCP.ps1' -ExampleNumber 1 Reads the content of 'C:\repos\NetworkingDsc\Examples\Resources\DhcpClient\1-DhcpClient_EnableDHCP.ps1' and converts it to markdown in preparation for being added to a resource wiki page. #> function Get-DscResourceWikiExampleContent { [CmdletBinding()] [OutputType([System.String])] param ( [Parameter(Mandatory = $true)] [System.String] $ExamplePath, [Parameter(Mandatory = $true)] [System.Int32] $ExampleNumber ) $exampleContent = Get-Content -Path $ExamplePath # Use a string builder to assemble the example description and code $exampleDescriptionStringBuilder = New-Object -TypeName System.Text.StringBuilder $exampleCodeStringBuilder = New-Object -TypeName System.Text.StringBuilder <# Step through each line in the source example and determine the content and act accordingly: \<#PSScriptInfo...#\> - Drop block \#Requires - Drop Line \<#...#\> - Drop .EXAMPLE, .SYNOPSIS and .DESCRIPTION but include all other lines Configuration ... - Include entire block until EOF #> $blockType = [WikiExampleBlockType]::None foreach ($exampleLine in $exampleContent) { Write-Debug -Message ('Processing Line: {0}' -f $exampleLine) # Determine the behavior based on the current block type switch ($blockType.ToString()) { 'PSScriptInfo' { Write-Debug -Message 'PSScriptInfo Block Processing' # Exclude PSScriptInfo block from any output if ($exampleLine -eq '#>') { Write-Debug -Message 'PSScriptInfo Block Ended' # End of the PSScriptInfo block $blockType = [WikiExampleBlockType]::None } } 'Configuration' { Write-Debug -Message 'Configuration Block Processing' # Include all lines in the configuration block in the code output $null = $exampleCodeStringBuilder.AppendLine($exampleLine) } 'ExampleCommentHeader' { Write-Debug -Message 'ExampleCommentHeader Block Processing' # Include all lines in Example Comment Header block except for headers $exampleLine = $exampleLine.TrimStart() if ($exampleLine -notin ('.SYNOPSIS', '.DESCRIPTION', '.EXAMPLE', '#>')) { # Not a header so add this to the output $null = $exampleDescriptionStringBuilder.AppendLine($exampleLine) } if ($exampleLine -eq '#>') { Write-Debug -Message 'ExampleCommentHeader Block Ended' # End of the Example Comment Header block $blockType = [WikiExampleBlockType]::None } } default { Write-Debug -Message 'Not Currently Processing Block' # Check the current line if ($exampleLine.TrimStart() -eq '<#PSScriptInfo') { Write-Debug -Message 'PSScriptInfo Block Started' $blockType = [WikiExampleBlockType]::PSScriptInfo } elseif ($exampleLine -match 'Configuration') { Write-Debug -Message 'Configuration Block Started' $null = $exampleCodeStringBuilder.AppendLine($exampleLine) $blockType = [WikiExampleBlockType]::Configuration } elseif ($exampleLine.TrimStart() -eq '<#') { Write-Debug -Message 'ExampleCommentHeader Block Started' $blockType = [WikiExampleBlockType]::ExampleCommentHeader } } } } # Assemble the final output $null = $exampleStringBuilder = New-Object -TypeName System.Text.StringBuilder $null = $exampleStringBuilder.AppendLine("### Example $ExampleNumber") $null = $exampleStringBuilder.AppendLine() $null = $exampleStringBuilder.AppendLine($exampleDescriptionStringBuilder) $null = $exampleStringBuilder.AppendLine('```powershell') $null = $exampleStringBuilder.Append($exampleCodeStringBuilder) $null = $exampleStringBuilder.Append('```') # ALways return CRLF as line endings to work cross platform. return ($exampleStringBuilder.ToString() -replace '\r?\n', "`r`n") } #EndRegion './Private/Get-DscResourceWikiExampleContent.ps1' 146 #Region './Private/Get-ModuleVersion.ps1' 0 <# .SYNOPSIS This function evaluates the version from a module manifest if the passed ModuleVersion is not already set. .PARAMETER OutputDirectory The path to the output folder where the module is built, e.g. 'c:\MyModule\output'. .PARAMETER ProjectName The name of the project, normally the name of the module that is being built. .EXAMPLE Get-ModuleVersion -OutputDirectory 'c:\MyModule\output' -ProjectName 'MyModule' -ModuleVersion $null Will evaluate the module version from the module manifest in the path c:\MyModule\output\MyModule\*\MyModule.psd1. .EXAMPLE Get-ModuleVersion -ModuleVersion '1.0.0-preview1'. Will return the module version as '1.0.0-preview1'. .NOTES This is the same function that exits in the module Sampler, so if the function there is moved or exposed it should be reused from there instead. #> function Get-ModuleVersion { [CmdletBinding()] [OutputType([System.String])] param ( [Parameter()] [System.String] $OutputDirectory, [Parameter()] [System.String] $ProjectName, [Parameter()] [System.String] $ModuleVersion ) if ([System.String]::IsNullOrEmpty($ModuleVersion)) { $moduleInfo = Import-PowerShellDataFile "$OutputDirectory/$ProjectName/*/$ProjectName.psd1" -ErrorAction 'Stop' if ($preReleaseTag = $moduleInfo.PrivateData.PSData.Prerelease) { $moduleVersion = $moduleInfo.ModuleVersion + "-" + $preReleaseTag } else { $moduleVersion = $moduleInfo.ModuleVersion } } else { <# This handles a previous version of the module that suggested to pass a version string with metadata in the CI pipeline that can look like this: 1.15.0-pr0224-0022+Sha.47ae45eb2cfed02b249f239a7c55e5c71b26ab76.Date.2020-01-07 #> $moduleVersion = ($moduleVersion -split '\+', 2)[0] } return $moduleVersion } #EndRegion './Private/Get-ModuleVersion.ps1' 72 #Region './Private/Get-MofSchemaObject.ps1' 0 <# .SYNOPSIS Get-MofSchemaObject is used to read a .schema.mof file for a DSC resource. .DESCRIPTION The Get-MofSchemaObject method is used to read the text content of the .schema.mof file that all MOF based DSC resources have. The object that is returned contains all of the data in the schema so it can be processed in other scripts. .PARAMETER FileName The full path to the .schema.mof file to process. .EXAMPLE $mof = Get-MofSchemaObject -FileName C:\repos\SharePointDsc\DSCRescoures\MSFT_SPSite\MSFT_SPSite.schema.mof This example parses a MOF schema file. #> function Get-MofSchemaObject { [CmdletBinding()] [OutputType([System.Collections.Hashtable])] param ( [Parameter(Mandatory = $true)] [System.String] $FileName ) $temporaryPath = $null # Determine the correct $env:TEMP drive switch ($true) { (-not (Test-Path -Path variable:IsWindows) -or $IsWindows) { # Windows PowerShell or PowerShell 6+ $temporaryPath = $env:TEMP } $IsMacOS { $temporaryPath = $env:TMPDIR throw 'NotImplemented: Currently there is an issue using the type [Microsoft.PowerShell.DesiredStateConfiguration.Internal.DscClassCache] on macOS. See issue https://github.com/PowerShell/PowerShell/issues/5970 and issue https://github.com/PowerShell/MMI/issues/33.' } $IsLinux { $temporaryPath = '/tmp' } Default { throw 'Cannot set the temporary path. Unknown operating system.' } } #region Workaround for OMI_BaseResource inheritance not resolving. $filePath = (Resolve-Path -Path $FileName).Path $tempFilePath = Join-Path -Path $temporaryPath -ChildPath "DscMofHelper_$((New-Guid).Guid).tmp" $moduleName = (Split-Path -Path $filePath -Leaf).Replace('.schema.mof', $null) $rawContent = (Get-Content -Path $filePath -Raw) -replace "$moduleName : OMI_BaseResource", $moduleName Set-Content -LiteralPath $tempFilePath -Value $rawContent -ErrorAction 'Stop' # .NET methods don't like PowerShell drives $tempFilePath = Convert-Path -Path $tempFilePath #endregion try { $exceptionCollection = [System.Collections.ObjectModel.Collection[System.Exception]]::new() $moduleInfo = [System.Tuple]::Create('Module', [System.Version] '1.0.0') $class = [Microsoft.PowerShell.DesiredStateConfiguration.Internal.DscClassCache]::ImportClasses( $tempFilePath, $moduleInfo, $exceptionCollection ) } catch { throw "Failed to import classes from file $FileName. Error $_" } finally { Remove-Item -LiteralPath $tempFilePath -Force } $attributes = foreach ($property in $class.CimClassProperties) { $state = switch ($property.flags) { { $_ -band [Microsoft.Management.Infrastructure.CimFlags]::Key } { 'Key' } { $_ -band [Microsoft.Management.Infrastructure.CimFlags]::Required } { 'Required' } { $_ -band [Microsoft.Management.Infrastructure.CimFlags]::ReadOnly } { 'Read' } default { 'Write' } } @{ Name = $property.Name State = $state DataType = $property.CimType ValueMap = $property.Qualifiers.Where( { $_.Name -eq 'ValueMap' }).Value IsArray = $property.CimType -gt 16 Description = $property.Qualifiers.Where( { $_.Name -eq 'Description' }).Value EmbeddedInstance = $property.Qualifiers.Where( { $_.Name -eq 'EmbeddedInstance' }).Value } } @{ ClassName = $class.CimClassName Attributes = $attributes ClassVersion = $class.CimClassQualifiers.Where( { $_.Name -eq 'ClassVersion' }).Value FriendlyName = $class.CimClassQualifiers.Where( { $_.Name -eq 'FriendlyName' }).Value } } #EndRegion './Private/Get-MofSchemaObject.ps1' 130 #Region './Private/Task.Generate_Conceptual_Help.ps1' 0 <# .SYNOPSIS This is the alias to the build task Generate_Conceptual_Help's script file. .DESCRIPTION This makes available the alias 'Task.Generate_Conceptual_Help' that is exported in the module manifest so that the build task can be correctly imported using for example Invoke-Build. .NOTES This is using the pattern lined out in the Invoke-Build repository https://github.com/nightroman/Invoke-Build/tree/master/Tasks/Import. #> Set-Alias -Name 'Task.Generate_Conceptual_Help' -Value "$PSScriptRoot/tasks/Generate_Conceptual_Help.build.ps1" #EndRegion './Private/Task.Generate_Conceptual_Help.ps1' 15 #Region './Private/Task.Generate_Wiki_Content.ps1' 0 <# .SYNOPSIS This is the alias to the build task Generate_Wiki_Content's script file. .DESCRIPTION This makes available the alias 'Task.Generate_Wiki_Content' that is exported in the module manifest so that the build task can be correctly imported using for example Invoke-Build. .NOTES This is using the pattern lined out in the Invoke-Build repository https://github.com/nightroman/Invoke-Build/tree/master/Tasks/Import. #> Set-Alias -Name 'Task.Generate_Wiki_Content' -Value "$PSScriptRoot/tasks/Generate_Wiki_Content.build.ps1" #EndRegion './Private/Task.Generate_Wiki_Content.ps1' 15 #Region './Public/New-DscResourcePowerShellHelp.ps1' 0 <# .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. The help files are output to the OutputPath directory if specified. If not, they are output to the relevant resource's 'en-US' directory either in the path set by 'ModulePath' or to 'DestinationModulePath' if set. A README.md with a text description must exist in the resource's subdirectory for the help file to be generated. To get examples added to the conceptual help the examples must be present in an individual resource example folder, e.g. 'Examples/Resources/<ResourceName>/1-Example.ps1'. Prefixing the value with a number will sort the examples in that order. These help files can then be read by passing the name of the resource as a parameter to Get-Help. .PARAMETER ModulePath The path to the root of the DSC resource module (where the PSD1 file is found). In this path the folder DSCResources must be present. .PARAMETER DestinationModulePath The destination module path can be used to set the path where module is built before being deployed. This must be set to the root of the built module, e.g 'c:\repos\ModuleName\output\ModuleName\1.0.0'. If OutputPath is also used at the same time that will override this path. .PARAMETER OutputPath The output path can be used to set the path where all the generated files will be saved (all files to the same path). .EXAMPLE New-DscResourcePowerShellHelp -ModulePath C:\repos\SharePointDsc This example shows how to generate help for a specific module .EXAMPLE New-DscResourcePowerShellHelp -ModulePath C:\repos\SharePointDsc -DestinationModulePath C:\repos\SharePointDsc\output\SharePointDsc\1.0.0 This example shows how to generate help for a specific module and output the result to a built module. .EXAMPLE New-DscResourcePowerShellHelp -ModulePath C:\repos\SharePointDsc -OutputPath C:\repos\SharePointDsc\en-US This example shows how to generate help for a specific module and output all the generated files to the same output path. .NOTES Line endings are hard-coded to CRLF to handle different platforms similar. #> function New-DscResourcePowerShellHelp { [CmdletBinding()] param ( [Parameter(Mandatory = $true)] [System.String] $ModulePath, [Parameter()] [System.String] $DestinationModulePath, [Parameter()] [System.String] $OutputPath ) $mofSearchPath = (Join-Path -Path $ModulePath -ChildPath '\**\*.schema.mof') $mofSchemas = @(Get-ChildItem -Path $mofSearchPath -Recurse) Write-Verbose -Message ($script:localizedData.FoundMofFilesMessage -f $mofSchemas.Count, $ModulePath) foreach ($mofSchema in $mofSchemas) { $result = (Get-MofSchemaObject -FileName $mofSchema.FullName) | Where-Object -FilterScript { ($_.ClassName -eq $mofSchema.Name.Replace('.schema.mof', '')) ` -and ($null -ne $_.FriendlyName) } $descriptionPath = Join-Path -Path $mofSchema.DirectoryName -ChildPath 'readme.md' if (Test-Path -Path $descriptionPath) { Write-Verbose -Message ($script:localizedData.GenerateHelpDocumentMessage -f $result.FriendlyName) $output = ".NAME`r`n" $output += " $($result.FriendlyName)" $output += "`r`n`r`n" $descriptionContent = Get-Content -Path $descriptionPath -Raw $descriptionContent = $descriptionContent -replace '\r?\n', "`r`n" $descriptionContent = $descriptionContent -replace '\r\n', "`r`n " $descriptionContent = $descriptionContent -replace '# Description\r\n ', ".DESCRIPTION" $descriptionContent = $descriptionContent -replace '\r\n\s{4}\r\n', "`r`n`r`n" $descriptionContent = $descriptionContent -replace '\s{4}$', '' $output += $descriptionContent $output += "`r`n" foreach ($property in $result.Attributes) { $output += ".PARAMETER $($property.Name)`r`n" $output += " $($property.State) - $($property.DataType)" $output += "`r`n" if ([string]::IsNullOrEmpty($property.ValueMap) -ne $true) { $output += " Allowed values: " $property.ValueMap | ForEach-Object { $output += $_ + ", " } $output = $output.TrimEnd(" ") $output = $output.TrimEnd(",") $output += "`r`n" } $output += " " + $property.Description $output += "`r`n`r`n" } $exampleSearchPath = "\Examples\Resources\$($result.FriendlyName)\*.ps1" $examplesPath = (Join-Path -Path $ModulePath -ChildPath $exampleSearchPath) $exampleFiles = @(Get-ChildItem -Path $examplesPath -ErrorAction SilentlyContinue) if ($exampleFiles.Count -gt 0) { $exampleCount = 1 Write-Verbose -Message "Found $($exampleFiles.count) Examples for resource $($result.FriendlyName)" foreach ($exampleFile in $exampleFiles) { $exampleContent = Get-DscResourceHelpExampleContent ` -ExamplePath $exampleFile.FullName ` -ExampleNumber ($exampleCount++) $exampleContent = $exampleContent -replace '\r?\n', "`r`n" $output += $exampleContent $output += "`r`n" } } else { Write-Warning -Message ($script:localizedData.NoExampleFileFoundWarning -f $result.FriendlyName) } $outputFileName = "about_$($result.FriendlyName).help.txt" if ($PSBoundParameters.ContainsKey('OutputPath')) { # Output to $OutputPath if specified. $savePath = Join-Path -Path $OutputPath -ChildPath $outputFileName } elseif ($PSBoundParameters.ContainsKey('DestinationModulePath')) { # Output to the resource 'en-US' directory in the DestinationModulePath. $null = $mofSchema.DirectoryName -match '(.+)(DSCResources|DSCClassResources)(.+)' $resourceRelativePath = $matches[3] $dscRootFolderName = $matches[2] $savePath = Join-Path -Path $DestinationModulePath -ChildPath $dscRootFolderName | Join-Path -ChildPath $resourceRelativePath | Join-Path -ChildPath 'en-US' | Join-Path -ChildPath $outputFileName } else { # Output to the resource 'en-US' directory in the ModulePath. $savePath = Join-Path -Path $mofSchema.DirectoryName -ChildPath 'en-US' | Join-Path -ChildPath $outputFileName } Write-Verbose -Message ($script:localizedData.OutputHelpDocumentMessage -f $savePath) $output | Out-File -FilePath $savePath -Encoding 'ascii' -Force } else { Write-Warning -Message ($script:localizedData.NoDescriptionFileFoundWarning -f $result.FriendlyName) } } } #EndRegion './Public/New-DscResourcePowerShellHelp.ps1' 196 #Region './Public/New-DscResourceWikiPage.ps1' 0 <# .SYNOPSIS New-DscResourceWikiPage generates wiki pages that can be uploaded to GitHub to use as public documentation for a module. .DESCRIPTION The New-DscResourceWikiPage cmdlet will review all of the MOF based resources in a specified module directory and will output the Markdown files to the specified directory. These help files include details on the property types for each resource, as well as a text description and examples where they exist. .PARAMETER OutputPath Where should the files be saved to .PARAMETER ModulePath The path to the root of the DSC resource module (where the PSD1 file is found, not the folder for and individual DSC resource) .EXAMPLE New-DscResourceWikiPage -ModulePath C:\repos\SharePointdsc -OutputPath C:\repos\SharePointDsc\en-US This example shows how to generate help for a specific module #> function New-DscResourceWikiPage { [CmdletBinding()] param ( [Parameter(Mandatory = $true)] [System.String] $OutputPath, [Parameter(Mandatory = $true)] [System.String] $ModulePath ) $mofSearchPath = Join-Path -Path $ModulePath -ChildPath '\**\*.schema.mof' $mofSchemaFiles = @(Get-ChildItem -Path $mofSearchPath -Recurse) Write-Verbose -Message ($script:localizedData.FoundMofFilesMessage -f $mofSchemaFiles.Count, $ModulePath) # Loop through all the Schema files found in the modules folder foreach ($mofSchemaFile in $mofSchemaFiles) { $mofSchema = Get-MofSchemaObject -FileName $mofSchemaFile.FullName | Where-Object -FilterScript { ($_.ClassName -eq $mofSchemaFile.Name.Replace('.schema.mof', '')) ` -and ($null -ne $_.FriendlyName) } $descriptionPath = Join-Path -Path $mofSchemaFile.DirectoryName -ChildPath 'readme.md' if (Test-Path -Path $descriptionPath) { Write-Verbose -Message ($script:localizedData.GenerateWikiPageMessage -f $mofSchema.FriendlyName) $output = New-Object -TypeName System.Text.StringBuilder $null = $output.AppendLine("# $($mofSchema.FriendlyName)") $null = $output.AppendLine('') $null = $output.AppendLine('## Parameters') $null = $output.AppendLine('') $null = $output.AppendLine('| Parameter | Attribute | DataType | Description | Allowed Values |') $null = $output.AppendLine('| --- | --- | --- | --- | --- |') foreach ($property in $mofSchema.Attributes) { # If the attribute is an array, add [] to the DataType string $dataType = $property.DataType if ($property.IsArray) { $dataType = $dataType.ToString() + '[]' } if ($property.EmbeddedInstance -eq 'MSFT_Credential') { $dataType = 'PSCredential' } $null = $output.Append("| **$($property.Name)** " + ` "| $($property.State) " + ` "| $dataType " + ` "| $($property.Description) |") if ([string]::IsNullOrEmpty($property.ValueMap) -ne $true) { $null = $output.Append(($property.ValueMap -Join ', ')) } $null = $output.AppendLine('|') } $descriptionContent = Get-Content -Path $descriptionPath -Raw # Change the description H1 header to an H2 $descriptionContent = $descriptionContent -replace '# Description', '## Description' $null = $output.AppendLine() $null = $output.AppendLine($descriptionContent) $exampleSearchPath = "\Examples\Resources\$($mofSchema.FriendlyName)\*.ps1" $examplesPath = (Join-Path -Path $ModulePath -ChildPath $exampleSearchPath) $exampleFiles = @(Get-ChildItem -Path $examplesPath -ErrorAction SilentlyContinue) if ($exampleFiles.Count -gt 0) { $null = $output.AppendLine('## Examples') $exampleCount = 1 foreach ($exampleFile in $exampleFiles) { Write-Verbose -Message "Adding Example file '$($exampleFile.Name)' to wiki page for $($mofSchema.FriendlyName)" $exampleContent = Get-DscResourceWikiExampleContent ` -ExamplePath $exampleFile.FullName ` -ExampleNumber ($exampleCount++) $null = $output.AppendLine() $null = $output.AppendLine($exampleContent) } } else { Write-Warning -Message ($script:localizedData.NoExampleFileFoundWarning -f $mofSchema.FriendlyName) } $outputFileName = "$($mofSchema.FriendlyName).md" $savePath = Join-Path -Path $OutputPath -ChildPath $outputFileName Write-Verbose -Message ($script:localizedData.OutputWikiPageMessage -f $savePath) $null = Out-File ` -InputObject ($output.ToString() -replace '\r?\n', "`r`n") ` -FilePath $savePath ` -Encoding utf8 ` -Force } else { Write-Warning -Message ($script:localizedData.NoDescriptionFileFoundWarning -f $mofSchema.FriendlyName) } } } #EndRegion './Public/New-DscResourceWikiPage.ps1' 143 |