forked from Azure/azure-powershell
-
Notifications
You must be signed in to change notification settings - Fork 0
/
GenerateHelp.ps1
45 lines (40 loc) · 1.65 KB
/
GenerateHelp.ps1
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
#Requires -Modules platyPS
[CmdletBinding()]
Param(
[Parameter()]
[Switch]$ValidateMarkdownHelp,
[Parameter()]
[Switch]$GenerateMamlHelp,
[Parameter()]
[string]$BuildConfig
)
Import-Module "$PSScriptRoot\HelpGeneration\HelpGeneration.psm1"
$HelpFolders = Get-ChildItem "help" -Recurse -Directory | where { $_.FullName -like "*$BuildConfig*" }
# ---------------------------------------------------------------------------------------------
if ($ValidateMarkdownHelp)
{
if (!(Test-Path -Path "$PSScriptRoot\..\src\Package\Exceptions"))
{
New-Item -Path "$PSScriptRoot\..\src\Package" -Name "Exceptions" -ItemType Directory
}
$SuppressedExceptionsPath = "$PSScriptRoot\..\src\Package\Exceptions"
$NewExceptionsPath = "$PSScriptRoot\..\src\Package"
Copy-Item -Path "$PSScriptRoot\HelpGeneration\Exceptions\ValidateHelpIssues.csv" -Destination $SuppressedExceptionsPath
New-Item -Path $NewExceptionsPath -Name ValidateHelpIssues.csv -ItemType File -Force | Out-Null
Add-Content "$NewExceptionsPath\ValidateHelpIssues.csv" "Module,Target,Description"
$HelpFolders | foreach { Validate-MarkdownHelp $_ $SuppressedExceptionsPath $NewExceptionsPath }
$Exceptions = Import-Csv "$NewExceptionsPath\ValidateHelpIssues.csv"
if (($Exceptions | Measure-Object).Count -gt 0)
{
$Exceptions | ft
throw "A markdown file containing the help for a cmdlet is incomplete. Please check the exceptions provided for more details."
}
else
{
Remove-Item -Path "$NewExceptionsPath\ValidateHelpIssues.csv" -Force
}
}
if ($GenerateMamlHelp)
{
$HelpFolders | foreach { Generate-MamlHelp $_ }
}