[core] Reinstate react/no-unused-prop-types eslint rule #34125
Conversation
|
@material-ui/core: parsed: -0.18% 😍, gzip: -0.32% 😍 |
.eslintrc.js
Outdated
| 'react/prop-types': 'error', | ||
| 'react/no-unused-prop-types': 'error', |
There was a problem hiding this comment.
Would it make sense to do the opposite? Disable the rule for .js files only? Having to disable the rule feels like the exception, not the norm.
I'm not even sure we should disable the rule in the first place to be honest.
There was a problem hiding this comment.
I'm not even sure we should disable the rule in the first place to be honest.
Yes, I have no idea yet on why packages/mui-base/src/Portal/Portal.js suddenly fails the rules. compared with e.g. packages/mui-material/src/Accordion/Accordion.js, which seems to be be quite similar in setup and is subject to the identical config.
The error seems to go away when I wrap the result of portal in a fragment. I guess it's not detecting Portal as a react component if it doesn't return a jsx tag or null
There was a problem hiding this comment.
Trying that approach in this PR, not sure whether there's any overhead in doing this. Also seems like there are some true positives in packages/mui-material/src/Hidden/HiddenJs.js
There was a problem hiding this comment.
Just realized another option, we could add
/* eslint-disable react/no-unused-prop-types */
// ...
/* eslint-enable react/no-unused-prop-types */around the generated prop types
There was a problem hiding this comment.
As for HiddenJs component - it's an internal one. IMO we shouldn't require proptypes in such cases as developers would see a duplicated error if they use a wrong prop (one from "public" Hidden, the second one from HiddenJs).
There was a problem hiding this comment.
It will be tricky to selectively turn off react/prop-types for internal only components. How would we define the rule in eslint?
I also just reviewed the HiddenCss component, and it looks like its proptypes aren't fully matching either.
There was a problem hiding this comment.
Yes, I suppose we could just disable the rule per file via a comment. Anyway, this can be out of scope of your PR.
| @@ -48,7 +48,11 @@ const Portal = React.forwardRef(function Portal(props, ref) { | |||
| return children; | |||
| } | |||
|
|
|||
| return mountNode ? ReactDOM.createPortal(children, mountNode) : mountNode; | |||
| return ( | |||
| <React.Fragment> | |||
There was a problem hiding this comment.
I have doubled check, <React.Fragment> is not shown in the React dev tools, so no DX downside.
Janpot
requested review from
mnajdova,
michaldudak,
siriwatknp and
hbjORbj
as code owners
Janpot
changed the title
michaldudak
changed the title
* Reinstate react/no-unused-prop-types rule * disable in js * leave this * Try out fragments * this needs to go in as well
Reinstate
react/no-unused-prop-typesfor typescript files as it also operates on typescript typesSee mui/mui-toolpad#866 (comment)