Dump-help question

Related Projects ArgumentParser
1

I was recently digging the output generated by the --experimental-dump-help option, looking at the potential to use it to generate integrated DocC documentation for CLI executables (related thread in DocC about CLI documentation).

As I was looking through the content and the visibility controls, I noticed that a command can be marked as hidden from display, very much like Arguments. However, that data doesn't appear to be reflected as a property in CommandInfoV0 (the struct that's generated to reflect this information externally).

Is there any reason this additional property shouldn't be included in the JSON/Struct that encodes the details for the help dump?

/cc @ronnqvist

2

No, that is an oversight and it should be added.

1 Like
3

Thanks!

I've opened help-dump structures should reflect hidden attribute for commands as well as arguments · Issue #668 · apple/swift-argument-parser · GitHub to capture that, with the idea that I'll submit a PR to extend the data structure, and make corresponding updates to generate-manual shortly.