docs: add/improve our command warnings #406
Merged
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
I'd have to either update this everywhere (which would be false) or update the test which feels like a lot at the moment
kanadgupta
commented
Dec 16, 2021
Comment on lines
-72
to
+80
| await expect(cli(['swagger', '--help'])).resolves.toMatchSnapshot(); | ||
| await expect(cli(['openapi', '--help'])).resolves.toMatchSnapshot(); | ||
| }); | ||
|
|
||
| it('should print usage for a given command if supplied as `help <command>`', async () => { | ||
| await expect(cli(['help', 'swagger'])).resolves.toMatchSnapshot(); | ||
| await expect(cli(['help', 'openapi'])).resolves.toMatchSnapshot(); | ||
| }); | ||
|
|
||
| it('should not surface args that are designated as hidden', async () => { | ||
| await expect(cli(['swagger', '--help'])).resolves.toMatchSnapshot(); | ||
| await expect(cli(['openapi', '--help'])).resolves.toMatchSnapshot(); |
There was a problem hiding this comment.
I figured it makes more sense to test our openapi command rather than our deprecated swagger command here, which resulted in a bunch of snapshot updates in __tests__/__snapshots__/index.test.js.snap.
kanadgupta
added
documentation
erunion
approved these changes
Dec 16, 2021
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
openapicommand with both aversionandidparameter, since theversionparameter is ignored in this case. This has created a lot of confusion for users so hopefully this warning should provide some clarificationconsole.warnand instead we had to use a standard shared chalk-formatted logger function? cc: @erunion)openapicommand and refreshed its corresponding snapshot (see this comment)🧬 QA & Testing
Do tests pass?