Fix for trailing whitespace issue #225 (#317)

* Fix to clean up trailing whitespace in during markdown generation #225

* Updated change log with reference to issue #225

* Update to fix test issues

Author: BernieWhite

CHANGELOG.md

@@ -3,6 +3,7 @@ CHANGELOG
 
 ## Not released
 
+* Clean up trailing whitespace during markdown generation [#225](https://github.com/PowerShell/platyPS/issues/225)
 
 ## 0.8.3
 

src/Markdown.MAML/Renderer/Markdownv2Renderer.cs

@@ -92,7 +92,7 @@ private void AddYamlHeader(Hashtable yamlHeader)
 
             foreach (var pair in sortedHeader)
             {
-                _stringBuilder.AppendFormat("{0}: {1}{2}", pair.Key, pair.Value, Environment.NewLine);
+                AppendYamlKeyValue(pair.Key, pair.Value);
             }
 
             _stringBuilder.AppendFormat("---{0}{0}", Environment.NewLine);
@@ -276,7 +276,7 @@ private void AddParameter(MamlParameter parameter, MamlCommand command)
             {
                 _stringBuilder.AppendFormat("```yaml{0}", Environment.NewLine);
 
-                _stringBuilder.AppendFormat("{0}: {1}{2}", MarkdownStrings.Type, parameter.Type, Environment.NewLine);
+                AppendYamlKeyValue(MarkdownStrings.Type, parameter.Type);
 
                 string parameterSetsString;
                 if (command.Syntax.Count == 1 || set.Item1.Count == command.Syntax.Count)
@@ -290,31 +290,43 @@ private void AddParameter(MamlParameter parameter, MamlCommand command)
                     parameterSetsString = JoinWithComma(set.Item1);
                 }
 
-                _stringBuilder.AppendFormat("{0}: {1}{2}", MarkdownStrings.Parameter_Sets, parameterSetsString, Environment.NewLine);
+                AppendYamlKeyValue(MarkdownStrings.Parameter_Sets, parameterSetsString);
 
-                _stringBuilder.AppendFormat("{0}: {1}{2}", MarkdownStrings.Aliases, JoinWithComma(parameter.Aliases), Environment.NewLine);
+                AppendYamlKeyValue(MarkdownStrings.Aliases, JoinWithComma(parameter.Aliases));
                 if (parameter.ParameterValueGroup.Count > 0)
                 {
-                    _stringBuilder.AppendFormat("{0}: {1}{2}", MarkdownStrings.Accepted_values, JoinWithComma(parameter.ParameterValueGroup), Environment.NewLine);
+                    AppendYamlKeyValue(MarkdownStrings.Accepted_values, JoinWithComma(parameter.ParameterValueGroup));
                 }
 
                 if (parameter.Applicable != null)
                 {
-                    _stringBuilder.AppendFormat("{0}: {1}{2}", MarkdownStrings.Applicable, JoinWithComma(parameter.Applicable), Environment.NewLine);
+                    AppendYamlKeyValue(MarkdownStrings.Applicable, JoinWithComma(parameter.Applicable));
                 }
 
                 _stringBuilder.AppendLine();
 
-                _stringBuilder.AppendFormat("{0}: {1}{2}", MarkdownStrings.Required, set.Item2.Required, Environment.NewLine);
-                _stringBuilder.AppendFormat("{0}: {1}{2}", MarkdownStrings.Position, set.Item2.IsNamed() ? "Named" : set.Item2.Position, Environment.NewLine);
-                _stringBuilder.AppendFormat("{0}: {1}{2}", MarkdownStrings.Default_value, string.IsNullOrWhiteSpace(parameter.DefaultValue) ? "None" : parameter.DefaultValue, Environment.NewLine);
-                _stringBuilder.AppendFormat("{0}: {1}{2}", MarkdownStrings.Accept_pipeline_input, parameter.PipelineInput, Environment.NewLine);
-                _stringBuilder.AppendFormat("{0}: {1}{2}", MarkdownStrings.Accept_wildcard_characters, parameter.Globbing, Environment.NewLine);
+                AppendYamlKeyValue(MarkdownStrings.Required, set.Item2.Required.ToString());
+                AppendYamlKeyValue(MarkdownStrings.Position, set.Item2.IsNamed() ? "Named" : set.Item2.Position);
+                AppendYamlKeyValue(MarkdownStrings.Default_value, string.IsNullOrWhiteSpace(parameter.DefaultValue) ? "None" : parameter.DefaultValue);
+                AppendYamlKeyValue(MarkdownStrings.Accept_pipeline_input, parameter.PipelineInput);
+                AppendYamlKeyValue(MarkdownStrings.Accept_wildcard_characters, parameter.Globbing.ToString());
 
                 _stringBuilder.AppendFormat("```{0}{0}", Environment.NewLine);
             }
         }
 
+        private void AppendYamlKeyValue(string key, string value)
+        {
+            if (string.IsNullOrEmpty(value))
+            {
+                _stringBuilder.AppendFormat("{0}:{1}", key, Environment.NewLine);
+
+                return;
+            }
+
+            _stringBuilder.AppendFormat("{0}: {1}{2}", key, value, Environment.NewLine);
+        }
+
         private void AddExamples(MamlCommand command)
         {
             AddHeader(ModelTransformerBase.COMMAND_ENTRIES_HEADING_LEVEL, MarkdownStrings.EXAMPLES);

test/Markdown.MAML.Test/Renderer/MarkdownV2RendererTests.cs

@@ -235,7 +235,7 @@ public void RendererProduceMarkdownV2Output()
             string markdown = renderer.MamlModelToString(command, metadata);
             Assert.Equal(@"---
 foo: bar
-null: 
+null:
 schema: 2.0.0
 ---
 
@@ -414,7 +414,7 @@ public void RenderesAllParameterSetMoniker()
 ```yaml
 Type: String
 Parameter Sets: (All)
-Aliases: 
+Aliases:
 
 Required: True
 Position: Named
@@ -427,7 +427,7 @@ public void RenderesAllParameterSetMoniker()
 ```yaml
 Type: String
 Parameter Sets: FirstSyntax
-Aliases: 
+Aliases:
 
 Required: True
 Position: Named
@@ -440,7 +440,7 @@ public void RenderesAllParameterSetMoniker()
 ```yaml
 Type: String
 Parameter Sets: SecondSyntax
-Aliases: 
+Aliases:
 
 Required: True
 Position: Named