Improve handling on empty title #122

CHANGELOG.md

@@ -7,6 +7,8 @@ What's changed since v0.7.0:
 - Engine features:
   - Added support for custom configuration key values. [#121](https://github.com/BernieWhite/PSDocs/issues/121)
     - See `about_PSDocs_Configuration` for more details.
+- General improvements:
+  - Improve handling when an empty document title is set. [#122](https://github.com/BernieWhite/PSDocs/issues/122)
 - Bug fixes:
   - Fixed use of error action preference with `Include` keyword. [#127](https://github.com/BernieWhite/PSDocs/issues/127)
 

src/PSDocs/Commands/TitleCommand.cs

@@ -1,4 +1,5 @@
 
+using PSDocs.Pipeline;
 using System.Management.Automation;
 
 namespace PSDocs.Commands
@@ -7,10 +8,16 @@ namespace PSDocs.Commands
     internal sealed class TitleCommand : KeywordCmdlet
     {
         [Parameter(Position = 0, Mandatory = true)]
+        [AllowNull, AllowEmptyString]
         public string Text { get; set; }
 
         protected override void BeginProcessing()
         {
+            if (string.IsNullOrEmpty(Text))
+            {
+                GetPipeline().Writer.WarnTitleEmpty();
+                return;
+            }
             GetBuilder().Title(Text);
         }
     }

src/PSDocs/Pipeline/PipelineWriter.cs

@@ -44,6 +44,14 @@ public static void WarnSourcePathNotFound(this IPipelineWriter writer)
             writer.WriteWarning(PSDocsResources.SourceNotFound);
         }
 
+        public static void WarnTitleEmpty(this IPipelineWriter writer)
+        {
+            if (writer == null)
+                return;
+
+            writer.WriteWarning(PSDocsResources.TitleEmpty);
+        }
+
         public static void ErrorInvariantCulture(this IPipelineWriter writer)
         {
             if (writer == null)

src/PSDocs/Resources/PSDocsResources.resx

@@ -155,4 +155,7 @@
     <value>The source was not found.</value>
     <comment>Occurs when the source file specified does not exist.</comment>
   </data>
+  <data name="TitleEmpty" xml:space="preserve">
+    <value>The specified document title is empty and will be skipped.</value>
+  </data>
 </root>

tests/PSDocs.Tests/FromFile.Keyword.Doc.ps1

@@ -257,4 +257,11 @@ Document 'MultipleTitle' {
     Title 'Title 2'
 }
 
+# Synopsis: Tests Title with empty or null string
+Document 'EmptyTitle' {
+    $value = ''
+    Title $notValue
+    Title $value
+}
+
 #endregion Title

tests/PSDocs.Tests/PSDocs.Title.Tests.ps1

@@ -25,6 +25,7 @@ Describe 'PSDocs -- Title keyword' -Tag Title {
             Path = $docFilePath
             InputObject = $testObject
             PassThru = $True
+            ErrorAction = [System.Management.Automation.ActionPreference]::Stop
         }
         It 'With single title' {
             $result = Invoke-PSDocument @invokeParams -Name 'SingleTitle';
@@ -34,5 +35,11 @@ Describe 'PSDocs -- Title keyword' -Tag Title {
             $result = Invoke-PSDocument @invokeParams -Name 'MultipleTitle';
             $result | Should -Match "^(`# Title 2(\r|\n|\r\n))";
         }
+        It 'With empty title' {
+            $Null = Invoke-PSDocument @invokeParams -Name 'EmptyTitle' -WarningAction SilentlyContinue -WarningVariable outWarnings;
+            $outWarnings = @($outWarnings);
+            $outWarnings | Should -Not -BeNullOrEmpty;
+            $outWarnings.Length | Should -Be 2;
+        }
     }
 }