Add -PassThru to ConvertTo-MarkdownFromHtml

Author: bryanbcook

src/public/ConvertTo-MarkdownFromHtml.ps1

@@ -11,6 +11,32 @@
 .PARAMETER OutFile
   The resulting markdown file, if specified.
 
+.PARAMETER PassThru
+  Return markdown content as output, in addition to writing it to disk.
+
+.EXAMPLE
+  # Convert HTML content to Markdown and save to a file
+  ConvertTo-MarkdownFromHtml -Content "<h1>Hello World</h1>" -OutFile "C:\path\to\file.md"
+
+.EXAMPLE
+  # Convert a HTML file to Markdown and save to a file
+  ConvertTo-MarkdownFromHtml -File "C:\path\to\file.html" -OutFile "C:\path\to\file.md"
+
+.EXAMPLE
+  # Convert a HTML file to Markdown and return the content
+  $content = ConvertTo-MarkdownFromHtml -File "C:\path\to\file.html"
+
+.EXAMPLE
+  # Convert HTML content to Markdown and return the content
+  $content = ConvertTo-MarkdownFromHtml -Content "<h1>Hello World</h1>"
+
+.EXAMPLE
+  # Convert HTML content to Markdown and save to a file, returning the content
+  $content = ConvertTo-MarkdownFromHtml -Content "<h1>Hello World</h1>" -OutFile "C:\path\to\file.md" -PassThru
+
+.EXAMPLE
+  # Convert a HTML file to Markdown and save to a file, returning the content
+  $content = ConvertTo-MarkdownFromHtml -File "C:\path\to\file.html" -OutFile "C:\path\to\file.md" -PassThru
 #>
 function ConvertTo-MarkdownFromHtml {
   param(
@@ -22,8 +48,12 @@ function ConvertTo-MarkdownFromHtml {
     [string]$Content,
 
     [Parameter(ParameterSetName = "FromFile")]
-    [Parameter(Mandatory=$false, ParameterSetName = "FromContent")]
-    [string]$OutFile
+    [Parameter(ParameterSetName = "FromContent")]
+    [string]$OutFile,
+
+    [Parameter(ParameterSetName = "FromFile")]
+    [Parameter(ParameterSetName = "FromContent")]
+    [switch]$PassThru
   )
 
   # when FromContent is specified, write the content to a temporary file
@@ -69,5 +99,9 @@ function ConvertTo-MarkdownFromHtml {
     Remove-Item $OutFile
   } 
 
-  return $content
+  # return output if not persisting to disk or PassThru is specified
+  if (!$PSBoundParameters.ContainsKey("OutFile") -or ($PassThru.IsPresent -and $PassThru)) {
+    Write-Verbose "Returning content"
+    return $content
+  }
 }

src/public/Get-BloggerPost.ps1

@@ -143,7 +143,7 @@ Function Get-BloggerPost {
           $file = "$title.md"
 
           $filePath = Join-Path -Path $OutDirectory -ChildPath $file
-          ConvertTo-MarkdownFromHtml -Content $result.content -OutFile $filePath > $null
+          ConvertTo-MarkdownFromHtml -Content $result.content -OutFile $filePath
           Set-MarkdownFrontMatter -File $filePath -Replace $frontMatter
           Write-Verbose "Post content saved to: $filePath"
         }

src/tests/ConvertTo-MarkdownFromHtml.Tests.ps1

@@ -1,79 +1,90 @@
 Describe "ConvertTo-MarkdownFromHtml" {
   BeforeAll {
     Import-Module $PSScriptRoot\_TestHelpers.ps1 -Force
-    
+    $script:inFile = "TestDrive:\123.html"
+    $script:outFile = "TestDrive:\123.md"
+    $script:htmlContent = "<h1>Hello World</h1>"
+    Set-Content -Path $script:inFile -Value $script:htmlContent
   }
 
   BeforeEach {
     Import-Module $PSScriptRoot\..\PSBlogger.psm1 -Force
   }
 
-  Context "Using Content" {
-
-    BeforeEach {
-      $outFile = "TestDrive:\123.md"
-      $htmlContent = "<h1>Hello World</h1>"
+  AfterEach {
+    if (Test-Path $outFile) {
+      Remove-Item $outFile -Force
     }
+  }
 
-    AfterEach {
-      if (Test-Path $outFile) {
-        Remove-Item $outFile -Force
-      }
-    }
+  Context "Using Content" {
 
-    It "Should save HTML content to a markdown file" {
+    It "Should convert HTML content to Markdown file" {
       # act
-      ConvertTo-MarkdownFromHtml -Content $htmlContent -OutFile $outFile
+      ConvertTo-MarkdownFromHtml -Content $script:htmlContent -OutFile $script:outFile
 
       # assert
-      Test-Path $outFile | Should -BeTrue
+      Test-Path $script:outFile | Should -BeTrue
+      $content = (Get-Content -Path $script:outFile -Raw).Split("`r")
+      $content[0] | Should -Be "# Hello World"
     }
 
-    It "Should convert HTML content to Markdown file" {
+    It "Should not persist to disk if OutFile is not specified" {
       # act
-      $content = ConvertTo-MarkdownFromHtml -Content $htmlContent -OutFile $outFile
+      $content = ConvertTo-MarkdownFromHtml -Content $script:htmlContent
 
       # assert
-      $content = (Get-Content -Path $outFile -Raw).Split("`r")
-      $content[0] | Should -Be "# Hello World"
+      $content | Should -Not -BeNullOrEmpty
+      Test-Path $script:outFile | Should -BeFalse
     }
 
-    It "Should not persist to disk if OutFile is not specified" {
+    It "Should return content when writing to disk if PassThru is specified" {
       # act
-      $content = ConvertTo-MarkdownFromHtml -Content $htmlContent
+      $content = ConvertTo-MarkdownFromHtml -Content $script:htmlContent -OutFile $script:outFile -PassThru
 
       # assert
       $content | Should -Not -BeNullOrEmpty
-      Test-Path $outFile | Should -BeFalse
+      Test-Path $script:outFile | Should -BeTrue
     }
   }
 
   Context "Using File" {
 
-    BeforeEach {
-      $htmlContent = "<h1>Hello World</h1>"
-      $htmlFile = "TestDrive:\123.html"
-      $markdownFile = "TestDrive:\123.md"
-      Set-Content -Path $htmlFile -Value $htmlContent
+    It "Should convert HTML content to Markdown and persist to OutFile" {
+      # act
+      ConvertTo-MarkdownFromHtml -File $script:inFile -OutFile $script:outFile
+
+      # assert
+      Test-Path $script:outFile | Should -BeTrue
+      $content = (Get-Content -Path $script:outFile -Raw).Split("`r")
+      $content[0] | Should -Be "# Hello World"
     }
 
     It "Should convert HTML file to Markdown" {
       # act
-      $content = ConvertTo-MarkdownFromHtml -File $htmlFile -OutFile $markdownFile
+      $content = ConvertTo-MarkdownFromHtml -File $script:inFile
 
       # assert
-      Test-Path $markdownFile | Should -BeTrue
-      $content = (Get-Content -Path $markdownFile -Raw).Split("`r")
-      $content[0] | Should -Be "# Hello World"
+      $content | Should -Not -BeNullOrEmpty
+      $content | Should -BeLike "# Hello World*"
+    }
+
+    It "Should delete temporary OutFile if OutFile is not specified" {
+      # act
+      $content = ConvertTo-MarkdownFromHtml -File $script:inFile
+
+      # assert
+      $content | Should -Not -BeNullOrEmpty
+      Test-Path $script:outFile | Should -BeFalse
     }
 
-    It "Should delete temporary file" {
+    It "Should return content when writing to disk if PassThru is specified" {
       # act
-      $content = ConvertTo-MarkdownFromHtml -File $htmlFile
+      $content = ConvertTo-MarkdownFromHtml -File $script:inFile -OutFile $script:outFile -PassThru
 
       # assert
       $content | Should -Not -BeNullOrEmpty
-      Test-Path $markdownFile | Should -BeFalse
+      Test-Path $script:outFile | Should -BeTrue
     }
   }
 }