Add the parameter ShowProgress for the New-ExternalHelp function (#360)

* Add the parameter ShowProgress for the New-ExternalHelp function

* Correct markdown help for the New-ExternalHelp

Author: it-praktyk

CHANGELOG.md

@@ -3,6 +3,8 @@ CHANGELOG
 
 ## Not released
 
+* The ShowProgress parameter was added to the New-ExternalHelp function. By default progress bars are not display to increase speed of files processing.
+
 ## 0.9.0
 
 * platyPS is now cross platform and works on powershell 6.0 as well as previous versions of powershell.

docs/New-ExternalHelp.md

@@ -14,7 +14,7 @@ Creates external help file based on markdown supported by PlatyPS.
 
 ```
 New-ExternalHelp -Path <String[]> -OutputPath <String> [-ApplicableTag <String[]>] [-Encoding <Encoding>]
- [-MaxAboutWidth <Int32>] [-ErrorLogFile <String>] [-Force] [<CommonParameters>]
+ [-MaxAboutWidth <Int32>] [-ErrorLogFile <String>] [-Force] [-ShowProgress] [<CommonParameters>]
 ```
 
 ## DESCRIPTION
@@ -203,6 +203,23 @@ Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
+### -ShowProgress
+Display progress bars under parsing existing markdown files.
+
+If this is used generating of help is much slower.
+
+```yaml
+Type: SwitchParameter
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
 ### CommonParameters
 This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
 

src/platyPS/platyPS.psm1

@@ -37,12 +37,6 @@ $script:MODULE_PAGE_ADDITIONAL_LOCALE = "Additional Locale"
 
 $script:MAML_ONLINE_LINK_DEFAULT_MONIKER = 'Online Version:'
 
-# Write-Progress is not very useful on coreclr
-if (Get-Variable -Name IsCoreClr -ValueOnly -ErrorAction SilentlyContinue) {
-    # silent Write-Progress
-    function Write-Progress() {}
-}
-
 function New-MarkdownHelp
 {
     [CmdletBinding()]
@@ -762,7 +756,9 @@ function New-ExternalHelp
 
         [string]$ErrorLogFile,
 
-        [switch]$Force
+        [switch]$Force,
+
+        [switch]$ShowProgress
     )
 
     begin
@@ -782,6 +778,11 @@ function New-ExternalHelp
             New-Item -Type Directory $OutputPath -ErrorAction SilentlyContinue > $null
             Write-Verbose "[New-ExternalHelp] Use $OutputPath as path to a directory"
         }
+
+        if ( -not $ShowProgress.IsPresent -or $(Get-Variable -Name IsCoreClr -ValueOnly -ErrorAction SilentlyContinue) )
+        {
+            Function Write-Progress() {}
+        }
     }
 
     process