New-MarkdownCommandHelp doesn't respect -Locale

[Gijsreyn]

Prerequisites

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

Steps to reproduce

When using the New-MarkdownCommandHelp, the docs state the following:

This parameter allows you to specify the language locale for the help files. By default, the cmdlet uses the current CultureInfo.

When I now create a new Markdown file using the command and specify the -Locale different from the default, it is not being respected.

Expected behavior

Locale metadata is added with the specified `-Locale`

Actual behavior

It always grabs the default

Error details

Environment data

Name                           Value
----                           -----
PSVersion                      7.5.1
PSEdition                      Core
GitCommitId                    7.5.1
OS                             Microsoft Windows 10.0.26100
Platform                       Win32NT
PSCompatibleVersions           {1.0, 2.0, 3.0, 4.0…}
PSRemotingProtocolVersion      2.3
SerializationVersion           1.1.0.1
WSManStackVersion              3.0

Version

1.0.0-preview5

Visuals

No response

[sdwheeler]

This is a bug that we need to fix post GA. This needs more investigation.

[teramako]

It's seems CommandHelp is create with the locale, but the locale is not reflected into the Metadata and is fixed to "en-US" or the locale of the execution environment.

platyPS/src/Transform/TransformBase.cs

Lines 57 to 58 in 7234f18

	CommandHelp cmdHelp = new(commandInfo.Name, commandInfo.ModuleName, Settings.Locale);
	cmdHelp.Metadata = MetadataUtils.GetCommandHelpBaseMetadataFromCommandInfo(commandInfo);

platyPS/src/Common/MetadataUtils.cs

Lines 45 to 59 in 7234f18

	public static OrderedDictionary GetCommandHelpBaseMetadataFromCommandInfo(CommandInfo commandInfo)
	{
	OrderedDictionary metadata = new()
	{
	{ "document type", "cmdlet" },
	{ "title", commandInfo.Name },
	{ "Module Name", commandInfo.ModuleName },
	{ "Locale", CultureInfo.CurrentCulture.Name == string.Empty ? "en-US" : CultureInfo.CurrentCulture.Name },
	{ "PlatyPS schema version", "2024-05-01" }, // was schema
	{ "HelpUri", GetHelpCodeMethods.GetHelpUri(new PSObject(commandInfo)) }, // was online version
	{ "ms.date", DateTime.Now.ToString("MM/dd/yyyy") },
	{ "external help file", GetHelpFileFromCommandInfo(commandInfo) }
	};
	return metadata;
	}

I think the specified locale will be reflected with MetadataUtils.GetCommandHelpBaseMetadata(cmdHelp) instead of MetadataUtils.GetCommandHelpBaseMetadataFromCommandInfo(commandInfo)

[ArmaanMcleod]

Had this problem occur as well.

Current workaround seems to just be setting/unsetting culture:

try {
    $originalCulture = [System.Globalization.CultureInfo]::CurrentCulture
    [System.Globalization.CultureInfo]::CurrentCulture = 'en-US'
    New-MarkdownCommandHelp -Command $command -OutputFolder $DocsPath -Force | Out-Null
}
finally {
    [System.Globalization.CultureInfo]::CurrentCulture = $originalCulture
}