Warn when multiple arguments were supplied to oneOf #244
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
Adds a different warning message for multiple arguments supplied to oneOf. A common mistake is to write oneOf(x, y, z) instead of oneOf([x, y, z]) and this should help developers identifying the error.
ljharb
reviewed
Dec 18, 2018
| @@ -825,6 +825,20 @@ describe('PropTypesDevelopmentReact15', () => { | |||
| typeCheckPass(PropTypes.oneOf('red', 'blue'), 'red'); | |||
| }); | |||
|
|
|||
| it('should warn but not error for invalid multiple arguments', () => { | |||
There was a problem hiding this comment.
Why is it better to warn here, and not throw an error? Wouldn’t that surface it most rapidly?
There was a problem hiding this comment.
I totally agree - it's my first contribution to prop-types so I'm being cautious here. I didn't want the output of neither oneOf('red') nor oneOf('red', 'blue') to change, as this may be considered breaking by some. So I just "enhanced" an error message in one of the cases.
ljharb
reviewed
Feb 8, 2019
|
Thanks for reviewing @ljharb. Force pushed to squash and change the unit tests to remove "instance of" from the strings you've changed. |
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.
Adds a different warning message for multiple arguments supplied to oneOf. A common mistake is to write
oneOf(x, y, z)instead ofoneOf([x, y, z])and this should help developers identifying the error.