Add no-mutation-props rule #1113

Fix change requests mentioned in #1145
jsx-eslint · Sep 7, 2017 · a0a700e · a0a700e
1 parent 63eaf60
commit a0a700e
Show file tree

Hide file tree

Showing 3 changed files with 23 additions and 33 deletions.
diff --git a/index.js b/index.js
@@ -124,7 +124,6 @@ module.exports = {
         'react/no-danger-with-children': 2,
         'react/no-deprecated': 2,
         'react/no-direct-mutation-state': 2,
-        'react/no-mutation-props': 2,
         'react/no-find-dom-node': 2,
         'react/no-is-mounted': 2,
         'react/no-render-return-value': 2,

diff --git a/lib/rules/no-mutation-props.js b/lib/rules/no-mutation-props.js
@@ -1,10 +1,9 @@
 /**
- * @fileoverview Prevent direct mutation of this.props
+ * @fileoverview Prevent mutation of this.props
  * @author Ian Schmitz
  */
 'use strict';
 
-var has = require('has');
 var Components = require('../util/Components');
 
 // ------------------------------------------------------------------------------
@@ -14,36 +13,29 @@ var Components = require('../util/Components');
 module.exports = {
   meta: {
     docs: {
-      description: 'Prevent direct mutation of this.props',
+      description: 'Prevent mutation of this.props',
       category: 'Possible Errors',
-      recommended: true
+      recommended: false
     }
   },
 
   create: Components.detect(function (context, components, utils) {
 
-    /**
-     * Checks if the component is valid
-     * @param {Object} component The component to process
-     * @returns {Boolean} True if the component is valid, false if not.
-     */
-    function isValid(component) {
-      return Boolean(component && !component.mutateProps);
-    }
-
     /**
      * Reports this.props mutations for a given component
      * @param {Object} component The component to process
      */
     function reportMutations(component) {
-      var mutation;
-      for (var i = 0, j = component.mutations.length; i < j; i++) {
-        mutation = component.mutations[i];
+      if (!component.mutations) {
+        return;
+      }
+
+      component.mutations.forEach(function(mutation) {
         context.report({
           node: mutation,
-          message: 'Do not mutate props.'
+          message: 'A component must never modify its own props.'
         });
-      }
+      });
     }
 
     // --------------------------------------------------------------------------
@@ -59,7 +51,7 @@ module.exports = {
         }
 
         item = node.left.object;
-        while (item.object.property) {
+        while (item.object && item.object.property) {
           item = item.object;
         }
 
@@ -68,20 +60,19 @@ module.exports = {
           var mutations = component && component.mutations || [];
           mutations.push(node.left.object);
           components.set(node, {
-            mutateProps: true,
             mutations: mutations
           });
         }
       },
 
       'Program:exit': function () {
         var list = components.list();
-        for (var component in list) {
-          if (!has(list, component) || isValid(list[component])) {
-            continue;
-          }
-          reportMutations(list[component]);
-        }
+
+        Object.keys(list).forEach(function (key) {
+          var component = list[key];
+
+          reportMutations(component);
+        });
       }
     };
 

diff --git a/tests/lib/rules/no-mutation-props.js b/tests/lib/rules/no-mutation-props.js
@@ -76,7 +76,7 @@ ruleTester.run('no-mutation-props', rule, {
     ].join('\n'),
     parserOptions: parserOptions,
     errors: [{
-      message: 'Do not mutate props.'
+      message: 'A component must never modify its own props.'
     }]
   }, {
     code: [
@@ -89,7 +89,7 @@ ruleTester.run('no-mutation-props', rule, {
     ].join('\n'),
     parserOptions: parserOptions,
     errors: [{
-      message: 'Do not mutate props.'
+      message: 'A component must never modify its own props.'
     }]
   }, {
     code: [
@@ -102,7 +102,7 @@ ruleTester.run('no-mutation-props', rule, {
     ].join('\n'),
     parserOptions: parserOptions,
     errors: [{
-      message: 'Do not mutate props.'
+      message: 'A component must never modify its own props.'
     }]
   }, {
     code: [
@@ -116,11 +116,11 @@ ruleTester.run('no-mutation-props', rule, {
     ].join('\n'),
     parserOptions: parserOptions,
     errors: [{
-      message: 'Do not mutate props.',
+      message: 'A component must never modify its own props.',
       line: 3,
       column: 5
     }, {
-      message: 'Do not mutate props.',
+      message: 'A component must never modify its own props.',
       line: 4,
       column: 5
     }]
@@ -139,7 +139,7 @@ ruleTester.run('no-mutation-props', rule, {
       ].join('\n'),
       parserOptions: parserOptions,
       errors: [{
-        message: 'Do not mutate props.'
+        message: 'A component must never modify its own props.'
       }]
     }*/
   ]