Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[POC] feat: show aliases under their own help section #404

Closed
wants to merge 3 commits into from

Conversation

RodEsp
Copy link
Contributor

@RodEsp RodEsp commented Apr 19, 2022

What does this PR do?

This makes aliases show up under their own section in the help output for a CLI instead of having them show up under the COMMANDS.

image

Testing instructions

  1. Get this branch locally
    1. Run yarn install
    2. Run yarn link
  2. Clone https://github.com/RodEsp/test-cli locally
    1. Run yarn install
    2. Run yarn link @oclif/core
    3. Run bin/dev help
  3. See hello-alias show up under ALIASES instead of COMMANDS

@purplecabbage
Copy link
Contributor

I sort of solved (part of) the same issue here: #492
In our case we have many aliases, so we only want them to show up when you do --help on the full subCommand.

If we used your solution we would get a crazy list as we have multilevel aliases.
for example:

aio runtime namespace list
aio runtime namespace ls
aio runtime ns list
aio runtime ns ls
aio rt namespace list
aio rt namespace ls
aio rt ns list
aio rt ns ls

@RodEsp RodEsp closed this Feb 9, 2023
@mdonnalley mdonnalley deleted the re/aliases-help-section branch September 29, 2023 21:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants