-
Notifications
You must be signed in to change notification settings - Fork 83
Description
Is your feature request related to a problem? Please describe.
Right now, if I want to add additional examples to my root command the only option I have is to convert it to a single command. Otherwise apart from adding newlines into description there isn't much I can do.
I noticed that Oclif core has some functionality which could potentially be modified to allow this.
Files to reference:
They have protected methods like formatRoot and protected description in Root which could potentially take additional config like reading description from markdown.
Describe the solution you'd like
The solution can be (with lowest hanging fruit to highest)
- Remove
protectedfromformatRootand allow users to extend it - Allow using
index.tsfiles insrc/commandswithout needing theSINGLE_COMMAND_CLI_SYMBOLunless the user has specified in their config.
Describe alternatives you've considered
I am trying to work around this by writing some hook and modifying the pjson object to add multiline colored documentation.