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.

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

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

Merged
merged 22 commits into from
Oct 31, 2017
Merged
Show file tree
Hide file tree
Changes from 14 commits
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
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
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: Received `true` for non-boolean attribute `unknown`.\n\n' +
'If you want `unknown` to appear in the DOM, cast it to a string. ' +
'For example, you can pass `unknown="true"` or `unknown={value.toString()}` instead.\n' +
' in div (at **)',
);
expectDev(console.error.calls.count()).toBe(1);
Expand Down
19 changes: 15 additions & 4 deletions packages/react-dom/src/__tests__/ReactDOMComponent-test.js
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`',
'Received `true` for non-boolean attribute `whatever`.\n\n' +
'If you want `whatever` to appear in the DOM, cast it to a string. ' +
'For example, you can pass `whatever="true"` or `whatever={value.toString()}` instead.',
);
});

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`',
'Received `true` for non-boolean attribute `whatever`.\n\n' +
'If you want `whatever` to appear in the DOM, cast it to a string. ' +
'For example, you can pass `whatever="true"` or `whatever={value.toString()}` instead.',
);
});

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`.',
'Received `true` for non-boolean attribute `whatever`.\n\n' +
'If you want `whatever` to appear in the DOM, cast it to a string. ' +
'For example, you can pass `whatever="true"` or `whatever={value.toString()}` instead.',
);
});

Expand Down Expand Up @@ -2283,7 +2289,12 @@ 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`.',
'Received `false` for non-boolean attribute `whatever`.\n\n ' +
'If you want `whatever` to appear in the DOM, cast it to a string. ' +
'For example, you can pass `whatever="false"` or `whatever={value.toString()}.\n\n' +
'If you want to omit `whatever` based on a condition, use a ternary expression. ' +
'For example, you can pass `whatever={condition ? value : undefined}` ' +
'instead of `whatever={condition && value}`.',
);
});
});
Expand Down
48 changes: 39 additions & 9 deletions packages/react-dom/src/shared/ReactDOMUnknownPropertyHook.js
Original file line number Diff line number Diff line change
Expand Up @@ -180,15 +180,45 @@ if (__DEV__) {
return true;
}

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',
value,
name,
getStackAddendum(),
);
if (
typeof value === 'boolean' &&
!DOMProperty.shouldAttributeAcceptBooleanValue(name)
) {
if (value === true) {
Copy link
Collaborator

Choose a reason for hiding this comment

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

Nit: we already know it's a boolean so can just write if (value)

warning(
false,
'Received `%s` for non-boolean attribute `%s`.\n\n' +
'If you want `%s` to appear in the DOM, cast it to a string. ' +
'For example, you can pass `%s="%s"` or `%s={value.toString()}` instead.%s',
value,
name,
name,
name,
value,
name,
getStackAddendum(),
);
} else {
warning(
false,
'Received `%s` for non-boolean attribute `%s`.\n\n ' +
'If you want `%s` to appear in the DOM, cast it to a string. ' +
'For example, you can pass `%s="%s"` or `%s={value.toString()}.\n\n' +
'If you want to omit `%s` based on a condition, use a ternary expression. ' +
'For example, you can pass `%s={condition ? value : undefined}` ' +
'instead of `%s={condition && value}`.%s',
value,
name,
name,
name,
value,
name,
name,
name,
name,
getStackAddendum(),
);
}
warnedProperties[name] = true;
return true;
Copy link
Collaborator

Choose a reason for hiding this comment

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

Why was this removed?

}
Expand Down