Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #1139 from amplitude/no-will-update-set-state
[New] Add no-will-update-set-state rule
- Loading branch information
Showing
8 changed files
with
413 additions
and
118 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,90 @@ | ||
| # Prevent usage of setState in componentWillUpdate (no-will-update-set-state) | ||
|
|
||
| Updating the state during the componentWillUpdate step can lead to indeterminate component state and is not allowed. | ||
|
|
||
| ## Rule Details | ||
|
|
||
| The following patterns are considered warnings: | ||
|
|
||
| ```jsx | ||
| var Hello = React.createClass({ | ||
| componentWillUpdate: function() { | ||
| this.setState({ | ||
| name: this.props.name.toUpperCase() | ||
| }); | ||
| }, | ||
| render: function() { | ||
| return <div>Hello {this.state.name}</div>; | ||
| } | ||
| }); | ||
| ``` | ||
|
|
||
| The following patterns are not considered warnings: | ||
|
|
||
| ```jsx | ||
| var Hello = React.createClass({ | ||
| componentWillUpdate: function() { | ||
| this.props.prepareHandler(); | ||
| }, | ||
| render: function() { | ||
| return <div>Hello {this.props.name}</div>; | ||
| } | ||
| }); | ||
| ``` | ||
|
|
||
| ```jsx | ||
| var Hello = React.createClass({ | ||
| componentWillUpdate: function() { | ||
| this.prepareHandler(function callback(newName) { | ||
| this.setState({ | ||
| name: newName | ||
| }); | ||
| }); | ||
| }, | ||
| render: function() { | ||
| return <div>Hello {this.props.name}</div>; | ||
| } | ||
| }); | ||
| ``` | ||
|
|
||
| ## Rule Options | ||
|
|
||
| ```js | ||
| ... | ||
| "no-will-update-set-state": [<enabled>, <mode>] | ||
| ... | ||
| ``` | ||
|
|
||
| ### `disallow-in-func` mode | ||
|
|
||
| By default this rule forbids any call to `this.setState` in `componentWillUpdate` outside of functions. The `disallow-in-func` mode makes this rule more strict by disallowing calls to `this.setState` even within functions. | ||
|
|
||
| The following patterns are considered warnings: | ||
|
|
||
| ```jsx | ||
| var Hello = React.createClass({ | ||
| componentDidUpdate: function() { | ||
| this.setState({ | ||
| name: this.props.name.toUpperCase() | ||
| }); | ||
| }, | ||
| render: function() { | ||
| return <div>Hello {this.state.name}</div>; | ||
| } | ||
| }); | ||
| ``` | ||
|
|
||
| ```jsx | ||
| var Hello = React.createClass({ | ||
| componentDidUpdate: function() { | ||
| this.prepareHandler(function callback(newName) { | ||
| this.setState({ | ||
| name: newName | ||
| }); | ||
| }); | ||
| }, | ||
| render: function() { | ||
| return <div>Hello {this.state.name}</div>; | ||
| } | ||
| }); | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| /** | ||
| * @fileoverview Prevent usage of setState in componentWillUpdate | ||
| * @author Yannick Croissant | ||
| */ | ||
| 'use strict'; | ||
|
|
||
| var makeNoMethodSetStateRule = require('../util/makeNoMethodSetStateRule'); | ||
|
|
||
| module.exports = makeNoMethodSetStateRule('componentWillUpdate'); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,70 @@ | ||
| /** | ||
| * @fileoverview Prevent usage of setState in lifecycle methods | ||
| * @author Yannick Croissant | ||
| */ | ||
| 'use strict'; | ||
|
|
||
| // ------------------------------------------------------------------------------ | ||
| // Rule Definition | ||
| // ------------------------------------------------------------------------------ | ||
|
|
||
| function makeNoMethodSetStateRule(methodName) { | ||
| return { | ||
| meta: { | ||
| docs: { | ||
| description: 'Prevent usage of setState in ' + methodName, | ||
| category: 'Best Practices', | ||
| recommended: false | ||
| }, | ||
|
|
||
| schema: [{ | ||
| enum: ['disallow-in-func'] | ||
| }] | ||
| }, | ||
|
|
||
| create: function(context) { | ||
|
|
||
| var mode = context.options[0] || 'allow-in-func'; | ||
|
|
||
| // -------------------------------------------------------------------------- | ||
| // Public | ||
| // -------------------------------------------------------------------------- | ||
|
|
||
| return { | ||
|
|
||
| CallExpression: function(node) { | ||
| var callee = node.callee; | ||
| if ( | ||
| callee.type !== 'MemberExpression' || | ||
| callee.object.type !== 'ThisExpression' || | ||
| callee.property.name !== 'setState' | ||
| ) { | ||
| return; | ||
| } | ||
| var ancestors = context.getAncestors(callee).reverse(); | ||
| var depth = 0; | ||
| for (var i = 0, j = ancestors.length; i < j; i++) { | ||
| if (/Function(Expression|Declaration)$/.test(ancestors[i].type)) { | ||
| depth++; | ||
| } | ||
| if ( | ||
| (ancestors[i].type !== 'Property' && ancestors[i].type !== 'MethodDefinition') || | ||
| ancestors[i].key.name !== methodName || | ||
| (mode !== 'disallow-in-func' && depth > 1) | ||
| ) { | ||
| continue; | ||
| } | ||
| context.report({ | ||
| node: callee, | ||
| message: 'Do not use setState in ' + methodName | ||
| }); | ||
| break; | ||
| } | ||
| } | ||
| }; | ||
|
|
||
| } | ||
| }; | ||
| } | ||
|
|
||
| module.exports = makeNoMethodSetStateRule; |
Oops, something went wrong.