Merge pull request #176 from ShaunLawrie/master

Fix #175

CHANGELOG.md

@@ -1,3 +1,12 @@
+### HelpOut 0.5.3:
+
+* Save-MarkdownHelp:
+  * Fix saving markdown with Windows paths ( #175 )
+
+Thanks @ShaunLawrie ! 
+
+---
+
 ### HelpOut 0.5.2:
 
 * Save-MarkdownHelp:

HelpOut.psd1

@@ -7,24 +7,20 @@
     ModuleToProcess='HelpOut.psm1'
     FormatsToProcess='HelpOut.format.ps1xml'
     TypesToProcess='HelpOut.types.ps1xml'
-    ModuleVersion='0.5.2'
+    ModuleVersion='0.5.3'
     PrivateData = @{
         PSData = @{
             ProjectURI = 'https://github.com/StartAutomating/HelpOut'
             LicenseURI = 'https://github.com/StartAutomating/HelpOut/blob/master/LICENSE'
 
             Tags = 'Markdown', 'Help','PowerShell'
             ReleaseNotes = @'
-### HelpOut 0.5.2:
+### HelpOut 0.5.3:
 
 * Save-MarkdownHelp:
-  * IncludeSubModule/-ExcludeSubModule ( #155 )
-  * -IncludePath ( #169 )
-  * -ExcludeFile aliases ( #168 )
-  * -ExcludeExtension ( #167 )
-  * Not Saving Files with colons ( #163 )
+  * Fix saving markdown with Windows paths ( #175 )
 
-Thanks @PrzemyslawKlys !
+Thanks @ShaunLawrie ! 
 
 ---
 

HelpOut.types.ps1xml

@@ -61,8 +61,13 @@ $FilePath,
 $View = 'PowerShell.Markdown.Help'
 )
 
-if ($filePath -match '[\<\>\|\?\*\:]') {
-    Write-Warning "Will not .Save to $filePath, because that path will not be readable on all operating systems."
+$illegalCharacters = @('<', '>', '|', '?', '*', ':')
+$illegalCharacterRegex = '[' + ($illegalCharacters | Foreach-Object { [regex]::Escape($_) }) + ']'
+$illegalCharacterReadable = ($illegalCharacters | Foreach-Object { "`"$_`"" }) -join ', '
+
+$filePathWithoutQualifier = Split-Path $filePath -NoQualifier
+if ($filePathWithoutQualifier -match $illegalCharacterRegex) {
+    Write-Warning "Will not .Save to $filePath, because that path will not be readable on all operating systems. It cannot contain any of the characters $illegalCharacterReadable."
     return
 }
 

Types/PowerShell.Markdown.Help/Save.ps1

@@ -22,8 +22,13 @@ $FilePath,
 $View = 'PowerShell.Markdown.Help'
 )
 
-if ($filePath -match '[\<\>\|\?\*\:]') {
-    Write-Warning "Will not .Save to $filePath, because that path will not be readable on all operating systems."
+$illegalCharacters = @('<', '>', '|', '?', '*', ':')
+$illegalCharacterRegex = '[' + ($illegalCharacters | Foreach-Object { [regex]::Escape($_) }) + ']'
+$illegalCharacterReadable = ($illegalCharacters | Foreach-Object { "`"$_`"" }) -join ', '
+
+$filePathWithoutQualifier = Split-Path $filePath -NoQualifier
+if ($filePathWithoutQualifier -match $illegalCharacterRegex) {
+    Write-Warning "Will not .Save to $filePath, because that path will not be readable on all operating systems. It cannot contain any of the characters $illegalCharacterReadable."
     return
 }