You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
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 protected from formatRoot and allow users to extend it
Allow using index.ts files in src/commands without needing the SINGLE_COMMAND_CLI_SYMBOL unless 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.
The text was updated successfully, but these errors were encountered:
NikhilVerma
changed the title
Allow root command to be configurable
Allow root command help to be configurable
Jan 2, 2025
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
andprotected 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)
protected
fromformatRoot
and allow users to extend itindex.ts
files insrc/commands
without needing theSINGLE_COMMAND_CLI_SYMBOL
unless 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.The text was updated successfully, but these errors were encountered: