[Feature Request] Expose commands metadata for generating custom help documents

[filzrev]

I want to generate help documents with following formats for command line application.

• HTML
• Markdown

But currently ConsoleAppFramework seems not have extensibility points for help.
And generated DLLs doesn't have related information. (Because it's generated by using Source Generator)

Is it able to expose related command metadata that required for generating help documents?

Another approach
If output of --help format is strictly defined by ConsoleAppFramework.
It might able to use help2man approach (Parse --help command output).

[neuecc]

It is a good suggestion.
I will consider a form where the default is disabled and the output is generated by GeneratorOptions.

[github-actions]

This issue is stale because it has been open 180 days with no activity. Remove stale label or comment or this will be closed in 30 days.

[filzrev]

Please do not close the Issue and leave it as is.

The feature that expected will include the following.

1. Enable JSON metadata generation by custom MSBuildProperty (that similar to GenerateDocumentationFile)
2. Generator load settings from AnalyzerConfigOptionsProvider and generate JSON metadata.
3. Metadata JSON is included as generator output.

[neuecc]

ok and sorry for no response.

[neuecc]

For metadata reference:
https://github.com/spectreconsole/open-cli

[filzrev]

It seems .NET 10 preview.6 dotnet command supports --cli-schema option new options to export command schema metadata.

[filzrev]

There is a commented that .NET CLI's --cli-schema will generate a schema aligned to OpenCLI in future.
dotnet/command-line-api#2632