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

Jump to bottom

Fixed invalid prop types error message to be more specific #11308

Merged
merged 22 commits into from
Oct 31, 2017
Merged

Fixed invalid prop types error message to be more specific #11308

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
2653595
Modified tests and corrected error message. #3
NicBonetto Oct 20, 2017
8de9a20
Fixed syntax issues. #3
NicBonetto Oct 20, 2017
4ce5b49
Modified test. #3
NicBonetto Oct 20, 2017
3d4724e
Prettified. #3
NicBonetto Oct 20, 2017
449b98d
Changed warning message to handle true and false boolean values. #3
NicBonetto Oct 24, 2017
bb7978c
Changed test to contain undefined instead of value. #3
NicBonetto Oct 24, 2017
05ecf0a
Simplified branch structure. #3
NicBonetto Oct 26, 2017
e18a235
Refactored branching logic. #3
NicBonetto Oct 26, 2017
9fc2b7f
Refactored falsy warning message and tests. #3
NicBonetto Oct 28, 2017
ede38f3
Changed condition to attribute name. #3
NicBonetto Oct 28, 2017
ae6fcbf
Refactored falsy and truthy warning messages with tests updated. #3
NicBonetto Oct 29, 2017
aada64c
Added missing character. #3
NicBonetto Oct 29, 2017
de26d9d
Fixed warning message. #3
NicBonetto Oct 29, 2017
c7ee43d
Cleared extra whitespace. #3
NicBonetto Oct 29, 2017
2c19ea3
Refactored warning messages to be clear. #3
NicBonetto Oct 29, 2017
37207a0
Prettified. #3
NicBonetto Oct 29, 2017
12db856
Grammar fix
gaearon Oct 31, 2017
69cbdfc
Tweak unrelated warning
gaearon Oct 31, 2017
c841d41
Tweak the message for more clarity
gaearon Oct 31, 2017
da20477
Add a special message for false event handlers
gaearon Oct 31, 2017
5b994bf
Add missing whitespace
gaearon Oct 31, 2017
425c00b
Revert size changes
gaearon Oct 31, 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
5 changes: 3 additions & 2 deletions packages/react-dom/src/__tests__/ReactDOMAttribute-test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,8 +54,9 @@ describe('ReactDOM unknown attribute', () => {
expectDev(
normalizeCodeLocInfo(console.error.calls.argsFor(0)[0]),
).toMatch(
'Warning: Received `true` for non-boolean attribute `unknown`. ' +
'If this is expected, cast the value to a string.\n' +
'Warning: If you intentionally tried to pass a boolean, pass it as a string ' +
'instead: `true`="`unknown`". If you mean to conditionally pass an ' +
'attribute, use a ternary expression: `true`={condition ? value : null}.\n' +
' in div (at **)',
);
expectDev(console.error.calls.count()).toBe(1);
Expand Down
16 changes: 12 additions & 4 deletions packages/react-dom/src/__tests__/ReactDOMComponent-test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2042,7 +2042,9 @@ describe('ReactDOMComponent', () => {
expect(el.hasAttribute('whatever')).toBe(false);

expectDev(console.error.calls.argsFor(0)[0]).toContain(
'Warning: Received `true` for non-boolean attribute `whatever`',
'If you intentionally tried to pass a boolean, pass it as a string ' +
'instead: `true`="`whatever`". If you mean to conditionally pass an ' +
'attribute, use a ternary expression: `true`={condition ? value : null}.',
);
});

Expand All @@ -2055,7 +2057,9 @@ describe('ReactDOMComponent', () => {
expect(el.hasAttribute('whatever')).toBe(false);

expectDev(console.error.calls.argsFor(0)[0]).toContain(
'Warning: Received `true` for non-boolean attribute `whatever`',
'If you intentionally tried to pass a boolean, pass it as a string ' +
'instead: `true`="`whatever`". If you mean to conditionally pass an ' +
'attribute, use a ternary expression: `true`={condition ? value : null}.',
);
});

Expand Down Expand Up @@ -2230,7 +2234,9 @@ describe('ReactDOMComponent', () => {
expect(el.hasAttribute('whatever')).toBe(false);

expectDev(console.error.calls.argsFor(0)[0]).toContain(
'Warning: Received `true` for non-boolean attribute `whatever`.',
'If you intentionally tried to pass a boolean, pass it as a string ' +
'instead: `true`="`whatever`". If you mean to conditionally pass an ' +
'attribute, use a ternary expression: `true`={condition ? value : null}.',
);
});

Expand Down Expand Up @@ -2283,7 +2289,9 @@ describe('ReactDOMComponent', () => {

expectDev(console.error.calls.count()).toBe(1);
expectDev(console.error.calls.argsFor(0)[0]).toContain(
'Warning: Received `false` for non-boolean attribute `whatever`.',
'If you intentionally tried to pass a boolean, pass it as a string ' +
'instead: `false`="`whatever`". If you mean to conditionally pass an ' +
'attribute, use a ternary expression: `false`={condition ? value : null}.',
);
});
});
Expand Down
6 changes: 4 additions & 2 deletions packages/react-dom/src/shared/ReactDOMUnknownPropertyHook.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -183,10 +183,12 @@ if (__DEV__) {
if (typeof value === 'boolean') {
warning(
DOMProperty.shouldAttributeAcceptBooleanValue(name),
'Received `%s` for non-boolean attribute `%s`. If this is expected, cast ' +
'the value to a string.%s',
'If you intentionally tried to pass a boolean, pass it as a string ' +
'instead: `%s`="`%s`". If you mean to conditionally pass an ' +
'attribute, use a ternary expression: `%s`={condition ? value : null}.%s',
Copy link
Collaborator

@sebmarkbage sebmarkbage Oct 21, 2017 •
edited
Loading

Choose a reason for hiding this comment

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

If the value is true then this is very unlikely to happen because the problematic pattern is condition && value specifically. I can't think of a way where you'd end up with true for the same reason. Maybe we should have two separate error messages for true and false where this recommendation is only for the false case?

Maybe also call out that the problematic pattern is condition && value specifically, so that people know what's wrong and what to look for along with your proposed recommendation.

Also, the recommendation should be to pass undefined, not null. It doesn't really matter for DOM components, but if it is a custom component that is the difference between defaultProps working and not working. So it's better to have consistent advice.

value,
name,
value,
getStackAddendum(),
);
warnedProperties[name] = true;
Expand Down