Skip to content

Import-MarkdownModuleFile and Import-MarkdownCommandFile incorrectly import multiline metadata #731

Open
@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

I added test metadata to the attached markdown files then imported them. The multiline Yaml value foo was not imported correctly.

PS> $m = Import-MarkdownModuleFile .\CimCmdlets.md
PS> $c = Import-MarkdownCommandHelp .\Get-CimAssociatedInstance.md

Expected behavior

PS> $m.Metadata

Name                           Value
----                           -----
HelpInfoUri                    https://aka.ms/powershell74-help
Help Version                   7.4.0.0
Locale                         en-US
Module Guid                    fb6cc51d-c096-4b38-b78d-0fed6277096a
Module Name                    CimCmdlets
ms.date                        02/20/2019
PlatyPS schema version         2024-05-01
title                          CimCmdlets Module
isPreview                      true
foo                            {bar}
test                           true
document type                  module

PS> $c.Metadata

Name                           Value
----                           -----
external help file             Microsoft.Management.Infrastructure.CimCmdlets.dll-Help.xml
Locale                         en-US
Module Name                    CimCmdlets
ms.date                        05/31/2024
HelpUri                        https://learn.microsoft.com/powershell/module/cimcmdlets/get-cimassociatedinstance?view…
PlatyPS schema version         2024-05-01
title                          Get-CimAssociatedInstance
foo                            {bar, baz}
test                           true
document type                  cmdlet

Actual behavior

PS> $m.Metadata

Name                           Value
----                           -----
HelpInfoUri                    https://aka.ms/powershell74-help
Help Version                   7.4.0.0
Locale                         en-US
Module Guid                    fb6cc51d-c096-4b38-b78d-0fed6277096a
Module Name                    CimCmdlets
ms.date                        02/20/2019
PlatyPS schema version         2024-05-01
title                          CimCmdlets Module
isPreview                      true
foo
aliases                        {bar}
document type                  module

PS> $c.Metadata

Name                           Value
----                           -----
external help file             Microsoft.Management.Infrastructure.CimCmdlets.dll-Help.xml
Locale                         en-US
Module Name                    CimCmdlets
ms.date                        05/31/2024
HelpUri                        https://learn.microsoft.com/powershell/module/cimcmdlets/get-cimassociatedinstance?view…
PlatyPS schema version         2024-05-01
title                          Get-CimAssociatedInstance
foo
aliases                        {bar, baz}
document type                  cmdlet

Also note that the `test` metadata key/value pair is missing from both example.

Error details

none

Environment data

Microsoft.PowerShell.PlatyPS built from latest commit in v2 branch - 33b90b4

Visuals

No response

Metadata

Metadata

Labels

BlockedTag - blocked on something external to this repoNeeds-TriageThe issue is new and needs to be triaged by a work group.

Type

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions