Add method to get help option description #1370
Milestone
Comments
Melissa0x1f992
changed the title
|
Best approach currently is a copy of the string, as you have done. There is a big refactor of the help in progress in #1365, but it does not provide access to the default descriptions. Will be interesting to see if this gets upvotes, now |
Closed
Melissa0x1f992
added a commit
to Melissa0x1f992/commander.js
that referenced
this issue
Oct 13, 2020
stdout isn't available to my user. I have a custom method of displaying text output to the user. I still want to make use of the full Commander help suite. Disabling the built-in help commands and writing wrappers becomes an increasingly complicated task when you want to make use of the entire help suite. This PR will solve that problem by removing the assumption that all output is to `process.stdout`. A user can instead pass a writeable stream that will replace the default stdout stream. In this way, anyone can output command results in any way that works for their use case by defining their own writeable stream. This is a more elegant solution to the problem in tj#1370. Instead of using `helpOption(false)` and writing my own help option, I can use Commander's help option, and handle the output with my own writeable stream. This is a less invasive solution than tj#779, as it leaves the implementation of the writeable stream to the user. Suggested changelog: "allow overriding the output from default (`process.stdout`) to any `stream.Writeable`" Things to note: * I've intentionally not updated the README or the examples/, as this is a WIP PR, and I'd like to know if this idea will be accepted before documenting it that far. * This adds a dependency on `stream.Writeable`, but that's built into Node, so I think that's fine * `process.stdout` is a `stream.Writeable`, but it's also a `tty.WriteStream`. Only the latter has the `.columns` field in its API. All of Commander's uses of that field are protected by a default if `.columns` is Falsey. So for that reason I've kept it simple with the understanding that if someone wants a non-default column width in their custom stream, they can specify that field themself. An alternative would be to create a type that's just a `stream.Writeable` + `.columns`. I think this alternative adds unneeded complexity, so I didn't go for it. However, it has the pro of not relying on the existing `.columns || 80` in the code to prevent undefined behavior.
Closed
|
Improving support for non-console help output in #1387 |
shadowspawn
added
the
pending release
|
Improved support for redirected output in Commander 7.0.0. |
shadowspawn
removed
the
pending release
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Something like
helpDescription()? And maybe when someone useshelpOption(..., 'custom description'), subsequent calls will return the new description?Context: I'm using
helpOption(false)to disable the implicit help because I have a non-console help output, and I'd rather not display help redundantly on the console. I usehelpInformation()to get the help string in the action of my own'-h, --help'option. I'd like my help description to match commander's default help option description. My current options are just to hardcode a copy of your string, or access the_helpDescriptionfield. I've opted for the former for now, but I'd rather not have a random copy of data when the intent was to refer to the already-existing data.The text was updated successfully, but these errors were encountered: