WIP: Update markdown help

.vscode/settings.json

@@ -2,5 +2,6 @@
 {
      "files.exclude": {
         "out/**": true
-    }
+    },
+    "sarif-viewer.connectToGithubCodeScanning": "off"
 }

src/GetMarkdownMetadataCommand.cs

@@ -44,7 +44,7 @@ protected override void ProcessRecord()
             {
                 if (Markdown is not null)
                 {
-                    DeserializeAndWrite(GetMarkdownMetadataHeaderReader(Markdown));
+                    DeserializeAndWrite(MarkdownUtilities.GetMarkdownMetadataHeaderReader(Markdown));
                 }
             }
             else if (string.Equals(this.ParameterSetName, "FromPath", StringComparison.OrdinalIgnoreCase))
@@ -55,7 +55,7 @@ protected override void ProcessRecord()
 
                     foreach (var resolvedPath in resolvedPaths)
                     {
-                        DeserializeAndWrite(GetMarkdownMetadataHeaderReader(File.ReadAllText(resolvedPath.Path)));
+                        DeserializeAndWrite(MarkdownUtilities.GetMarkdownMetadataHeaderReader(File.ReadAllText(resolvedPath.Path)));
                     }
                 }
             }
@@ -68,33 +68,5 @@ private void DeserializeAndWrite(string headerContent)
             var deserializer = new YamlDotNet.Serialization.DeserializerBuilder().Build();
             WriteObject(deserializer.Deserialize(stringReader));
         }
-
-        private string GetMarkdownMetadataHeaderReader(string content)
-        {
-            if (string.IsNullOrEmpty(content))
-            {
-                return string.Empty;
-            }
-
-            var mdAst = Markdig.Markdown.Parse(content);
-
-            if (mdAst.Count < 2)
-            {
-                return string.Empty;
-            }
-
-            if (mdAst[0] is Markdig.Syntax.ThematicBreakBlock)
-            {
-                if (mdAst[1] is Markdig.Syntax.HeadingBlock metadata)
-                {
-                    if (metadata.Inline?.FirstChild is Markdig.Syntax.Inlines.LiteralInline metadataText)
-                    {
-                        return metadataText.Content.Text;
-                    }
-                }
-            }
-
-            return string.Empty;
-        }
     }
 }

src/MarkdownUtilities.cs

@@ -0,0 +1,39 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+
+namespace Microsoft.PowerShell.PlatyPS
+{
+    internal class MarkdownUtilities
+    {
+        internal static string GetMarkdownMetadataHeaderReader(string content)
+        {
+            if (string.IsNullOrEmpty(content))
+            {
+                return string.Empty;
+            }
+
+            var mdAst = Markdig.Markdown.Parse(content);
+
+            if (mdAst.Count < 2)
+            {
+                return string.Empty;
+            }
+
+            if (mdAst[0] is Markdig.Syntax.ThematicBreakBlock)
+            {
+                if (mdAst[1] is Markdig.Syntax.HeadingBlock metadata)
+                {
+                    if (metadata.Inline?.FirstChild is Markdig.Syntax.Inlines.LiteralInline metadataText)
+                    {
+                        return metadataText.Content.Text;
+                    }
+                }
+            }
+
+            return string.Empty;
+        }
+    }
+}

src/Microsoft.PowerShell.PlatyPS.csproj

@@ -11,11 +11,13 @@
     <LangVersion>latest</LangVersion>
     <HighEntropyVA>true</HighEntropyVA>
     <Nullable>enable</Nullable>
+    <GenerateAssemblyInfo>false</GenerateAssemblyInfo>
+    <GenerateTargetFrameworkAttribute>false</GenerateTargetFrameworkAttribute>
     <SuppressNETCoreSdkPreviewMessage>true</SuppressNETCoreSdkPreviewMessage>
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="Markdig.Signed" Version="[0.18.3]" />
+    <PackageReference Include="Markdig.Signed" Version="0.30.4" />
     <PackageReference Include="PowerShellStandard.Library" Version="5.1.0" PrivateAssets="All" />
     <PackageReference Include="Microsoft.CSharp" Version="4.7.0" />
     <PackageReference Include="YamlDotNet" Version="11.0.1" />

src/Model/Constants.cs

@@ -110,6 +110,8 @@ internal static class Constants
         internal const string ModuleGuidHeaderTemplate = "Module Guid: {0}";
         internal const string FillInGuid = "XXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX";
         internal const string LocaleEnUs = "en-US";
+        internal const char Comma = ',';
+        internal const string CommonParametersHeader = "CommonParameters";
         internal static readonly List<string> EmptyStringList = new();
         internal static readonly char DirectorySeparator = System.IO.Path.DirectorySeparatorChar;
 

src/NewMarkownHelpCommand.cs

@@ -92,6 +92,7 @@ public sealed class NewMarkdownHelpCommand : PSCmdlet
         [Parameter(ParameterSetName = "FromMaml")]
         public string? ModulePagePath { get; set; }
 
+        [Parameter()]
         public SwitchParameter ExcludeDontShow { get; set; }
 
         #endregion