Skip to content

Import-MarkdownModuleFile doesn't handle empty description section #760

@sdwheeler

Description

@sdwheeler

Prerequisites

  • Write a descriptive title.
  • Make sure you are able to repro it on the latest released version
  • Search the existing issues.

Steps to reproduce

Microsoft.SystemCenter.ServiceManagementAutomation.md

When the description of the module is empty, the command imports the next H2 as the description. This causes CommandGroups to be empty.

$m = Import-MarkdownModuleFile .\Microsoft.SystemCenter.ServiceManagementAutomation.md
$m.Diagnostics.Messages

Source                Severity    Message                                                                 Identifier
------                --------    -------                                                                 ----------
ModuleFileTitle       Information {Title Microsoft.SystemCenter.ServiceManagementAutomation Module found} GetModuleFil…
Metadata              Information {found guid 03f356fb-485d-41bc-b7fe-7f573ecc186f}                       GetMetadata
Metadata              Information {found module name Microsoft.SystemCenter.ServiceManagementAutomation}  GetMetadata
Metadata              Information {locale set to en-US}                                                   GetMetadata
ModuleFileDescription Information {Module description found}                                              GetModuleFil…

$m

Metadata      : {[HelpInfoUri, ], [Help Version, 5.0.0.0], [Locale, en-US], [Module Guid,
                03F356FB-485D-41BC-B7FE-7F573ECC186F]…}
Title         : Microsoft.SystemCenter.ServiceManagementAutomation Module
Module        : Microsoft.SystemCenter.ServiceManagementAutomation
ModuleGuid    : 03f356fb-485d-41bc-b7fe-7f573ecc186f
Description   : ## Microsoft.SystemCenter.ServiceManagementAutomation Cmdlets
Locale        : en-US
CommandGroups : {}
Diagnostics   : Microsoft.PowerShell.PlatyPS.Model.Diagnostics

Expected behavior

Description should be empty. CommandGroups should be populated.

Actual behavior

Metadata      : {[HelpInfoUri, ], [Help Version, 5.0.0.0], [Locale, en-US], [Module Guid,
                03F356FB-485D-41BC-B7FE-7F573ECC186F]…}
Title         : Microsoft.SystemCenter.ServiceManagementAutomation Module
Module        : Microsoft.SystemCenter.ServiceManagementAutomation
ModuleGuid    : 03f356fb-485d-41bc-b7fe-7f573ecc186f
Description   : ## Microsoft.SystemCenter.ServiceManagementAutomation Cmdlets
Locale        : en-US
CommandGroups : {}
Diagnostics   : Microsoft.PowerShell.PlatyPS.Model.Diagnostics

Error details

Environment data

gmo Microsoft.PowerShell.PlatyPS

ModuleType Version    PreRelease Name                                ExportedCommands
---------- -------    ---------- ----                                ----------------
Script     1.0.0      preview5   Microsoft.PowerShell.PlatyPS        {Compare-CommandHelp, Export-MamlCommandHelp, Exp…

Visuals

No response

Metadata

Metadata

Labels

BlockedTag - blocked on something external to this repo

Type

No type

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions