Skip to content
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

Issue#11510: added verification check for misspelled propTypes #11524

Merged
merged 11 commits into from
Nov 24, 2017
+57 −1
Merged

Issue#11510: added verification check for misspelled propTypes #11524

Changes from 2 commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
ec5279a
added verification check for misspelled propTypes
Nov 10, 2017
5f39533
added flag to check if misspelled warning was shown to developer before
Nov 11, 2017
4eaae3d
added the condition to else if and improved the warning message
Nov 14, 2017
e297922
Merge branch 'master' of github.com:facebook/react into misspelled-pr…
Nov 14, 2017
f381561
moved variable under dev section & initialized it to false
Nov 14, 2017
0b557d9
added test to confirm the missmatch prop type warning in both and t…
Nov 14, 2017
c39a009
Merge branch 'master' of github.com:facebook/react into misspelled-pr…
Nov 22, 2017
dddcf9b
removed eslint disable and split error into 2 lines
Nov 22, 2017
6d15d49
Merge branch 'master' of github.com:facebook/react into misspelled-pr…
Nov 23, 2017
601bec9
changed expectDev to expect in tests
Nov 23, 2017
e71096a
added __DEV__ condition before both tests
Nov 23, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion packages/react/src/ReactElementValidator.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -214,14 +214,24 @@ function validateChildKeys(node, parentType) {
*
* @param {ReactElement} element
*/
var propTypesMisspellWarningShown;
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we move this up to other DEV only variables?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also let's initialise it to false.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added the variable declaration under if(__DEV__){ which is after import statements. Now working on test.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should the test be added in both ReactElementValidator-test and ReactJSXElementValidator-test?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think just one is fine.

Copy link
Author

@M-ZubairAhmed M-ZubairAhmed Nov 14, 2017 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh i just added test in both of them, i pushed my code. Should i remove from one ?
Also i have verified all tests were passing and ran build in my local example which was reproducing the error.
I was wondering if i should add another test it(should not show any errors is correct propTypes property assignment is passed)?

function validatePropTypes(element) {
var componentClass = element.type;
if (typeof componentClass !== 'function') {
return;
}
var name = componentClass.displayName || componentClass.name;
var propTypes = componentClass.propTypes;

if (
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe let's put it into an else clause to the next if?

if (propTypes) {
  // ...
} else if (componentClass.PropTypes && !propTypesMisspellWarningShown) {
  // ...
}

Copy link
Author

@M-ZubairAhmed M-ZubairAhmed Nov 14, 2017 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have also tested this in fixtures/dom by introducing some props and misspelling propTypes

componentClass.PropTypes !== undefined &&
!propTypesMisspellWarningShown
) {
propTypesMisspellWarningShown = true;
warning(
false,
'Static propTypes method should be accessed by `.propTypes = { }` instead of `.PropTypes = { }`',
Copy link
Collaborator

@gaearon gaearon Nov 13, 2017 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's reword to say:

Component %s declared `PropTypes` instead of `propTypes`. Did you misspell the property assignment?

And pass the component name name || 'Unknown' as an argument.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

changes done. Thank you @gaearon for being so patient with me.

);
}
if (propTypes) {
currentlyValidatingElement = element;
checkPropTypes(propTypes, element.props, 'prop', name, getStackAddendum);
Expand Down