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

[New] Add no-pure-component-children rule #1975

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,7 @@ Enable the rules that you would like to use.
* [react/no-find-dom-node](docs/rules/no-find-dom-node.md): Prevent usage of `findDOMNode`
* [react/no-is-mounted](docs/rules/no-is-mounted.md): Prevent usage of `isMounted`
* [react/no-multi-comp](docs/rules/no-multi-comp.md): Prevent multiple component definition per file
* [react/no-pure-component-children](docs/rules/no-pure-component-children.md): Prevent using `React.PureComponent` with children
* [react/no-redundant-should-component-update](docs/rules/no-redundant-should-component-update.md): Prevent usage of `shouldComponentUpdate` when extending React.PureComponent
* [react/no-render-return-value](docs/rules/no-render-return-value.md): Prevent usage of the return value of `React.render`
* [react/no-set-state](docs/rules/no-set-state.md): Prevent usage of `setState`
Expand Down
54 changes: 54 additions & 0 deletions docs/rules/no-pure-component-children.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
# Prevent using React.PureComponent with children (react/no-pure-component-children)

Warns if you have defined children PropTypes when defining a component that extends React.PureComponent.
Children props are almost never equal, and when they're not, React.PureComponent performs worse than React.Component.

## Rule Details

The following patterns are considered warnings:

```jsx
class Foo extends React.PureComponent {
render() {
return <div>Radical!</div>
}
}

Foo.propTypes = {
children: PropTypes.node,
};

class Bar extends React.PureComponent {
static propTypes = {
children: PropTypes.node,
};

render() {
return <div>Groovy!</div>
}
}
```

The following patterns are **not** considered warnings:

```jsx
class Foo extends React.Component {
render() {
return <div>Radical!</div>
}
}

Foo.propTypes = {
children: PropTypes.node,
};

class Bar extends React.Component {
static propTypes = {
children: PropTypes.node,
};

render() {
return <div>Groovy!</div>
}
}
```
1 change: 1 addition & 0 deletions index.js
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,7 @@ const allRules = {
'no-find-dom-node': require('./lib/rules/no-find-dom-node'),
'no-is-mounted': require('./lib/rules/no-is-mounted'),
'no-multi-comp': require('./lib/rules/no-multi-comp'),
'no-pure-component-children': require('./lib/rules/no-pure-component-children'),
'no-set-state': require('./lib/rules/no-set-state'),
'no-string-refs': require('./lib/rules/no-string-refs'),
'no-redundant-should-component-update': require('./lib/rules/no-redundant-should-component-update'),
Expand Down
54 changes: 54 additions & 0 deletions lib/rules/no-pure-component-children.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
/**
* @fileoverview Prevent using React.PureComponent with children
*/
'use strict';

const Components = require('../util/Components');
const docsUrl = require('../util/docsUrl');
const has = require('has');

// ------------------------------------------------------------------------------
// Rule Definition
// ------------------------------------------------------------------------------
module.exports = {
meta: {
docs: {
description: 'Prevent using React.PureComponent with children',
category: 'Best Practices',
recommended: false,
url: docsUrl('no-pure-component-children')
},
schema: []
},
create: Components.detect((context, components, utils) => ({
ClassDeclaration: function(node) {
if (utils.isPureComponent(node)) {
components.set(node, {
isPureComponent: true
});
}
},
'Program:exit': function() {
const list = components.list();

for (const key in list) {
if (!has(list, key)) {
continue;
}

const component = list[key];
if (!component.declaredPropTypes || !component.isPureComponent) {
continue;
}

if (component.declaredPropTypes.children) {
context.report(
component.declaredPropTypes.children.node,
'Do not use children with PureComponent',
{name: 'children'}
);
}
}
}
}))
};
Loading