feat: add --aliases flag for readme command
#925
Conversation
There was a problem hiding this comment.
@shazron thanks for the contribution - this is a great idea!
src/commands/readme.ts
Outdated
| } | ||
|
|
||
| static aliases = ['rdm'] |
There was a problem hiding this comment.
I'd prefer to not put an alias on this command unless there's overwhelming demand for it
There was a problem hiding this comment.
Me neither, but I will have to figure out another way to test this then...
There was a problem hiding this comment.
@shazron You can emulate the tests that use the fixtures. For example,
oclif/test/unit/readme.test.ts
Line 63 in da5a4d2
Basically, you just need to add a CLI with an alias'd command to the fixtures directory and use that for your test case
There was a problem hiding this comment.
gotcha, I'll amend the PR
There was a problem hiding this comment.
@mdonnalley I've resolved it to use a custom fixture. However the tests are failing due to AWS_ACCESS_KEY_ID not being set. I assumed the CI would set this in its environment, but it's failing there as well. Those tests are not relevant to this PR and I never touched them.
This is to allow for
--no-aliasesso the README being generated for a plugin does not include aliases, which may clutter the documentation.Example usage in
package.json:{ "scripts": { "prepack": "oclif manifest && oclif readme --no-aliases" } }