Fix bug in HelpGeneration script that is failing the on-demand build, add checks that will prevent infinite looping within a file

cormacpayne · cormacpayne · commit 4a4ef905d5b4 · 2017-09-01T09:45:07.000-07:00
diff --git a/tools/HelpGeneration/HelpGeneration.psm1 b/tools/HelpGeneration/HelpGeneration.psm1
@@ -118,6 +118,11 @@ function Validate-MarkdownHelp
                             if ($content[$idx+1] -notcontains "## SYNTAX")
                             {
                                 $idx++
+                                if ($idx -ge $content.Length)
+                                {
+                                    Write-Error "Could not find SYNTAX header in file $($file.Name)"
+                                    return
+                                }
                             }
                             elseif ($content[$idx] -contains "{{Fill in the Synopsis}}")
                             {
@@ -147,6 +152,11 @@ function Validate-MarkdownHelp
                             if ($content[$idx+1] -notcontains "## EXAMPLES")
                             {
                                 $idx++
+                                if ($idx -ge $content.Length)
+                                {
+                                    Write-Error "Could not find EXAMPLES header in file $($file.Name)"
+                                    return
+                                }
                             }
                             elseif ($content[$idx] -contains "{{Fill in the Description}}")
                             {
@@ -167,9 +177,14 @@ function Validate-MarkdownHelp
                     "## EXAMPLES"
                     {
                         # Move the index to the start of the PowerShell code
-                        while ($content[$idx] -notcontains "``````")
+                        while ($content[$idx] -notcontains "``````" -and $content[$idx] -notcontains "``````powershell")
                         {
                             $idx++
+                            if ($idx -ge $content.Length)
+                            {
+                                Write-Error "Could not find start of PowerShell example in file $($file.Name)"
+                                return
+                            }
                         }
 
                         # Check for the platyPS example template

Original file line number	Diff line number	Diff line change
`@@ -118,6 +118,11 @@ function Validate-MarkdownHelp`
`118`	`118`	`if ($content[$idx+1] -notcontains "## SYNTAX")`
`119`	`119`	`{`
`120`	`120`	`$idx++`
	`121`	`+ if ($idx -ge $content.Length)`
	`122`	`+ {`
	`123`	`+ Write-Error "Could not find SYNTAX header in file $($file.Name)"`
	`124`	`+ return`
	`125`	`+ }`
`121`	`126`	`}`
`122`	`127`	`elseif ($content[$idx] -contains "{{Fill in the Synopsis}}")`
`123`	`128`	`{`
`@@ -147,6 +152,11 @@ function Validate-MarkdownHelp`
`147`	`152`	`if ($content[$idx+1] -notcontains "## EXAMPLES")`
`148`	`153`	`{`
`149`	`154`	`$idx++`
	`155`	`+ if ($idx -ge $content.Length)`
	`156`	`+ {`
	`157`	`+ Write-Error "Could not find EXAMPLES header in file $($file.Name)"`
	`158`	`+ return`
	`159`	`+ }`
`150`	`160`	`}`
`151`	`161`	`elseif ($content[$idx] -contains "{{Fill in the Description}}")`
`152`	`162`	`{`
`@@ -167,9 +177,14 @@ function Validate-MarkdownHelp`
`167`	`177`	`"## EXAMPLES"`
`168`	`178`	`{`
`169`	`179`	`# Move the index to the start of the PowerShell code`
`170`		- while ($content[$idx] -notcontains "``````")
	`180`	+ while ($content[$idx] -notcontains "``````" -and $content[$idx] -notcontains "``````powershell")
`171`	`181`	`{`
`172`	`182`	`$idx++`
	`183`	`+ if ($idx -ge $content.Length)`
	`184`	`+ {`
	`185`	`+ Write-Error "Could not find start of PowerShell example in file $($file.Name)"`
	`186`	`+ return`
	`187`	`+ }`
`173`	`188`	`}`
`174`	`189`
`175`	`190`	`# Check for the platyPS example template`