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.

Sign up for GitHub

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

Jump to bottom

new oclif readme generator produces command output for aliases as well #362

Closed

shazron opened this issue Jul 26, 2022 · 5 comments

Labels

bug

Member

shazron commented Jul 26, 2022 •

edited

This will pollute the README with duplicate command help.

Related oclif/oclif#888

Member Author

shazron commented Jul 27, 2022

Readme command:
https://github.com/oclif/oclif/blob/main/src/commands/readme.ts

Where the list of commands are set:
https://github.com/oclif/core/blob/f759fb1710eb1013a48fa04e817d43231553590a/src/config/config.ts#L615-L621

The only approach I can think is to add a filter here:
https://github.com/oclif/oclif/blob/fb5da961f925fa0eba5c5b05c8cee0c9bd156c00/src/commands/readme.ts#L57

if c.id exists in c.aliases, remove it from the list.

Member Author

shazron commented Jul 27, 2022

Just tested it, it works:

.filter(c => !c.aliases.includes(c.id))

Member Author

shazron commented Jul 27, 2022

PR oclif/oclif#925

shazron added the bug label

aiojbot commented Aug 11, 2022

JIRA issue created: https://jira.corp.adobe.com/browse/ACNA-1742

Member Author

shazron commented Sep 7, 2022

Fixed in https://github.com/oclif/oclif/releases/tag/v3.2.0 (dev dep for all our plugins and cli)

shazron closed this as completed

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment