Fix errors for New-MarkdownHelp ps1 input (#446) (#450)

Author: natescherer

src/platyPS/platyPS.psm1

@@ -192,6 +192,7 @@ function New-MarkdownHelp
                 }
 
                 $commandName = $mamlObject.Name
+
                 # create markdown
                 if ($NoMetadata)
                 {
@@ -206,10 +207,20 @@ function New-MarkdownHelp
                     }
                     else
                     {
-                        $a = @{
-                            Name = $commandName
+                        # Get-Command requires that script input be a path
+                        if ($mamlObject.Name.EndsWith(".ps1"))
+                        {
+                            $getCommandName = Resolve-Path $Command
+                        }
+                        # For cmdlets, nothing needs to be done
+                        else
+                        {
+                            $getCommandName = $commandName
                         }
 
+                        $a = @{
+                            Name = $getCommandName
+                        }
                         if ($module) {
                             # for module case, scope it just to this module
                             $a['Module'] = $module
@@ -1810,39 +1821,42 @@ function GetHelpFileName
                 return $CommandInfo.HelpFile
             }
         }
-
-        # overwise, lets guess it
-        $module = @($CommandInfo.Module) + ($CommandInfo.Module.NestedModules) |
-            Where-Object {$_.ModuleType -ne 'Manifest'} |
-            Where-Object {$_.ExportedCommands.Keys -contains $CommandInfo.Name}
-
-        if (-not $module)
+        # only run module evaluations if the input command isn't a script
+        if ($CommandInfo.CommandType -ne "ExternalScript")
         {
-            Write-Warning -Message ($LocalizedData.ModuleNotFoundFromCommand -f '[GetHelpFileName]', $CommandInfo.Name)
-            return
-        }
+            # overwise, lets guess it
+            $module = @($CommandInfo.Module) + ($CommandInfo.Module.NestedModules) |
+                Where-Object {$_.ModuleType -ne 'Manifest'} |
+                Where-Object {$_.ExportedCommands.Keys -contains $CommandInfo.Name}
 
-        if ($module.Count -gt 1)
-        {
-            Write-Warning -Message ($LocalizedData.MultipleModulesFoundFromCommand -f '[GetHelpFileName]', $CommandInfo.Name)
-            $module = $module | Select-Object -First 1
-        }
+            if (-not $module)
+            {
+                Write-Warning -Message ($LocalizedData.ModuleNotFoundFromCommand -f '[GetHelpFileName]', $CommandInfo.Name)
+                return
+            }
 
-        if (Test-Path $module.Path -Type Leaf)
-        {
-            # for regular modules, we can deduct the filename from the module path file
-            $moduleItem = Get-Item -Path $module.Path
-            if ($moduleItem.Extension -eq '.psm1') {
-                $fileName = $moduleItem.BaseName
-            } else {
-                $fileName = $moduleItem.Name
+            if ($module.Count -gt 1)
+            {
+                Write-Warning -Message ($LocalizedData.MultipleModulesFoundFromCommand -f '[GetHelpFileName]', $CommandInfo.Name)
+                $module = $module | Select-Object -First 1
+            }
+
+            if (Test-Path $module.Path -Type Leaf)
+            {
+                # for regular modules, we can deduct the filename from the module path file
+                $moduleItem = Get-Item -Path $module.Path
+                if ($moduleItem.Extension -eq '.psm1') {
+                    $fileName = $moduleItem.BaseName
+                } else {
+                    $fileName = $moduleItem.Name
+                }
+            }
+            else
+            {
+                # if it's something like Dynamic module,
+                # we  guess the desired help file name based on the module name
+                $fileName = $module.Name
             }
-        }
-        else
-        {
-            # if it's something like Dynamic module,
-            # we  guess the desired help file name based on the module name
-            $fileName = $module.Name
         }
 
         return "$fileName-help.xml"

test/Pester/PlatyPs.Tests.ps1

@@ -146,6 +146,63 @@ Describe 'New-MarkdownHelp' {
         }
     }
 
+    Context 'from external script' { 
+        It 'fully qualified path' {
+            $SeedData = @"
+<# 
+.SYNOPSIS
+    Synopsis Here.
+
+.DESCRIPTION 
+    Description Here.
+
+.INPUTS
+    None
+
+.OUTPUTS
+    None
+
+.EXAMPLE
+    .\Invoke-HelloWorld.ps1
+
+#>
+
+Write-Host 'Hello World!'
+"@
+            Set-Content -Value $SeedData -Path TestDrive:\Invoke-HelloWorld.ps1 -NoNewline
+            $files = New-MarkdownHelp -Command "TestDrive:\Invoke-HelloWorld.ps1" -OutputFolder TestDrive:\output -Force
+            ($files | Measure-Object).Count | Should Be 1
+        }
+        It 'relative path' {
+            $SeedData = @"
+<# 
+.SYNOPSIS
+    Synopsis Here.
+
+.DESCRIPTION 
+    Description Here.
+
+.INPUTS
+    None
+
+.OUTPUTS
+    None
+
+.EXAMPLE
+    .\Invoke-HelloWorld.ps1
+
+#>
+
+Write-Host 'Hello World!'
+"@
+            Set-Content -Value $SeedData -Path TestDrive:\Invoke-HelloWorld.ps1 -NoNewline
+            $Location = Get-Location
+            Set-Location TestDrive:\
+            $files = New-MarkdownHelp -Command "TestDrive:\Invoke-HelloWorld.ps1" -OutputFolder TestDrive:\output -Force
+            Set-Location $Location
+            ($files | Measure-Object).Count | Should Be 1
+        }
+    }
     Context 'AlphabeticParamsOrder' {
         function global:Get-Alpha
         {