improve topic help resolution if @oclif/plugin-help
isn't available as a plugin
#848
Labels
enhancement
New feature or request
Is your feature request related to a problem? Please describe.
when running typing
<cli> <topic>
without having@oclif/plugin-help
as a plugin/devPlugin oclif fails to get topic help text and renders and instead throwsError: command help not found
:Examples using this plugin: https://github.com/cristiand391/sf-plugin-api/
this is caused by core trying to run
help <topic>
whenid
is a valid topic:core/src/main.ts
Line 77 in 7aec22e
example:
./bin/dev org
->id = org
org
is a valid topic in my plugin so it tries to runhelp org
to render the help text.Workaround
use
--help
so that core loads the helpclass without thehelp
command:core/src/main.ts
Line 65 in 7aec22e
Describe the solution you'd like
IMO, CLI plugins shouldn't be required to bring in
@oclif/plugin-help
as a devDependency. What if core just loads the helpclass instead of callinghelp
.If that's not possible, maybe the
command help not found
could be improved.Describe alternatives you've considered
--help
works.Additional context
Found by Rupert Barrow 😉 , just wanted to file an issue with what I found while trying to get and answer for him:
https://trailhead.salesforce.com/trailblazer-community/feed/0D54V00007OYgsj
The text was updated successfully, but these errors were encountered: