Account for UNSAFE_ method in no-will-update-set-state

Resolves #1844
jsx-eslint · Jun 24, 2018 · 40c4ffa · 40c4ffa
1 parent 7869530
commit 40c4ffa
Show file tree

Hide file tree

Showing 3 changed files with 61 additions and 6 deletions.
diff --git a/lib/rules/no-will-update-set-state.js b/lib/rules/no-will-update-set-state.js
@@ -5,5 +5,9 @@
 'use strict';
 
 const makeNoMethodSetStateRule = require('../util/makeNoMethodSetStateRule');
+const versionUtil = require('../util/version');
 
-module.exports = makeNoMethodSetStateRule('componentWillUpdate');
+module.exports = makeNoMethodSetStateRule(
+  'componentWillUpdate',
+  context => versionUtil.testReactVersion(context, '16.3.0')
+);
diff --git a/lib/util/makeNoMethodSetStateRule.js b/lib/util/makeNoMethodSetStateRule.js
@@ -10,7 +10,7 @@ const docsUrl = require('./docsUrl');
 // Rule Definition
 // ------------------------------------------------------------------------------
 
-function makeNoMethodSetStateRule(methodName) {
+function makeNoMethodSetStateRule(methodName, shouldCheckUnsafeCb) {
   return {
     meta: {
       docs: {
@@ -28,6 +28,15 @@ function makeNoMethodSetStateRule(methodName) {
     create: function(context) {
       const mode = context.options[0] || 'allow-in-func';
 
+      function nameMatches(name) {
+        let matches = name === methodName;
+        if (typeof shouldCheckUnsafeCb === 'function' && shouldCheckUnsafeCb(context)) {
+          matches = matches || name === `UNSAFE_${methodName}`;
+        }
+
+        return matches;
+      }
+
       // --------------------------------------------------------------------------
       // Public
       // --------------------------------------------------------------------------
@@ -46,19 +55,20 @@ function makeNoMethodSetStateRule(methodName) {
           const ancestors = context.getAncestors(callee).reverse();
           let depth = 0;
           for (let i = 0, j = ancestors.length; i < j; i++) {
-            if (/Function(Expression|Declaration)$/.test(ancestors[i].type)) {
+            const ancestor = ancestors[i];
+            if (/Function(Expression|Declaration)$/.test(ancestor.type)) {
               depth++;
             }
             if (
-              (ancestors[i].type !== 'Property' && ancestors[i].type !== 'MethodDefinition') ||
-              ancestors[i].key.name !== methodName ||
+              (ancestor.type !== 'Property' && ancestor.type !== 'MethodDefinition') ||
+              !nameMatches(ancestor.key.name) ||
               (mode !== 'disallow-in-func' && depth > 1)
             ) {
               continue;
             }
             context.report({
               node: callee,
-              message: `Do not use setState in ${methodName}`
+              message: `Do not use setState in ${ancestor.key.name}`
             });
             break;
           }

diff --git a/tests/lib/rules/no-will-update-set-state.js b/tests/lib/rules/no-will-update-set-state.js
@@ -77,6 +77,18 @@ ruleTester.run('no-will-update-set-state', rule, {
       });
     `,
     parser: 'babel-eslint'
+  }, {
+    code: `
+      class Hello extends React.Component {
+        UNSAFE_componentWillUpdate() {
+          this.setState({
+            data: data
+          });
+        }
+      }
+    `,
+    parser: 'babel-eslint',
+    settings: {react: {version: '16.2.0'}}
   }],
 
   invalid: [{
@@ -225,5 +237,34 @@ ruleTester.run('no-will-update-set-state', rule, {
     errors: [{
       message: 'Do not use setState in componentWillUpdate'
     }]
+  }, {
+    code: `
+      class Hello extends React.Component {
+        UNSAFE_componentWillUpdate() {
+          this.setState({
+            data: data
+          });
+        }
+      }
+    `,
+    parser: 'babel-eslint',
+    settings: {react: {version: '16.3.0'}},
+    errors: [{
+      message: 'Do not use setState in UNSAFE_componentWillUpdate'
+    }]
+  }, {
+    code: `
+      var Hello = createReactClass({
+        UNSAFE_componentWillUpdate: function() {
+          this.setState({
+            data: data
+          });
+        }
+      });
+    `,
+    settings: {react: {version: '16.3.0'}},
+    errors: [{
+      message: 'Do not use setState in UNSAFE_componentWillUpdate'
+    }]
   }]
 });