feat: experiment with a decorator to hide commands from the help screen #574
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
kanadgupta
reviewed
Aug 19, 2022
|
Running into all sorts of issues with the |
erunion
added
the
command:other
kanadgupta
approved these changes
Aug 20, 2022
| @@ -10,6 +10,7 @@ export function getCategories(): Record< | |||
| name: string; | |||
| description: string; | |||
| position: number; | |||
| hidden: boolean; | |||
There was a problem hiding this comment.
we really do have so many stupid little moving parts in these command helper functions. thank god for TS
There was a problem hiding this comment.
honestly blown away by how much the rewrite has been helping us this past week
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
🧰 Changes
This adds a new
@isHiddendecorator that when applied to a command class will hide it from all--helpscreens. This decorator is being applied to the inactiveoasand deprecatedswaggercommands.🧬 QA & Testing
npm run debug -- --helpyou shouldn't seeoasorswaggeranywhere.npm run debug -- openapi --helpyou shouldn't seeswaggerin the "Related commands" section.Run
npm run buildand then do the same checks against./bin/rdmeand you should see the same.