Add allowDecorators option to require-optimization

Author: Tom910

docs/rules/require-optimization.md

@@ -52,14 +52,30 @@ React.createClass({
 
 ```js
 ...
-"require-optimization": [<enabled>]
+"require-optimization": [<enabled>, { allowDecorators: [<allowDecorator>] }]
 ...
 ```
 
+* `enabled`: for enabling the rule. 0=off, 1=warn, 2=error. Defaults to 0.
+* `allowDecorators`: optional array of decorators names to allow validation.
+
+
+### `allowDecorators`
+
+Sets the allowed names of decorators. If the variable is present in the chain of decorators, it validates
+
+The following patterns are not warnings:
+
+```js
+// ['pureRender']
+@pureRender
+class Hello extends React.Component {}
+```
+
 ### Example
 
 ```js
 ...
-"require-optimization": 2
+"require-optimization": [2, {allowDecorators: ['customDecorators']}]
 ...
 ```

lib/rules/require-optimization.js

@@ -8,6 +8,8 @@ var Components = require('../util/Components');
 
 module.exports = Components.detect(function (context, components) {
   var MISSING_MESSAGE = 'Component is not optimized. Please add a shouldComponentUpdate method.';
+  var configuration = context.options[0] || {};
+  var allowDecorators = configuration.allowDecorators || [];
 
   /**
    * Checks to see if our component is decorated by PureRenderMixin via reactMixin
@@ -36,6 +38,30 @@ module.exports = Components.detect(function (context, components) {
     return false;
   };
 
+  /**
+   * Checks to see if our component is custom decorated
+   * @param {ASTNode} node The AST node being checked.
+   * @returns {Boolean} True if node is decorated name with a custom decorated, false if not.
+   */
+  var hasCustomDecorator = function (node) {
+    var allowLenght = allowDecorators.length;
+
+    if (allowLenght && node.decorators && node.decorators.length) {
+      for (var i = 0; i < allowLenght; i++) {
+        for (var j = 0, l = node.decorators.length; j < l; j++) {
+          if (
+            node.decorators[j].expression &&
+            node.decorators[j].expression.name === allowDecorators[i]
+          ) {
+            return true;
+          }
+        }
+      }
+    }
+
+    return false;
+  };
+
   /**
    * Checks if we are declaring a shouldComponentUpdate method
    * @param {ASTNode} node The AST node being checked.
@@ -102,7 +128,7 @@ module.exports = Components.detect(function (context, components) {
     },
 
     ClassDeclaration: function (node) {
-      if (!hasPureRenderDecorator(node)) {
+      if (!(hasPureRenderDecorator(node) || hasCustomDecorator(node))) {
         return;
       }
       markSCUAsDeclared(node);
@@ -148,3 +174,16 @@ module.exports = Components.detect(function (context, components) {
     }
   };
 });
+
+module.exports.schema = [{
+  type: 'object',
+  properties: {
+    allowDecorators: {
+      type: 'array',
+      items: {
+        type: 'string'
+      }
+    }
+  },
+  additionalProperties: false
+}];

tests/lib/rules/require-optimization.js

@@ -77,6 +77,17 @@ ruleTester.run('react-require-optimization', rule, {
     ].join('\n'),
     parser: 'babel-eslint',
     parserOptions: parserOptions
+  }, {
+    code: [
+      '@bar',
+      '@pureRender',
+      '@foo',
+      'class DecoratedComponent extends Component {' +
+      '}'
+    ].join('\n'),
+    parser: 'babel-eslint',
+    options: [{allowDecorators: ['renderPure', 'pureRender']}],
+    parserOptions: parserOptions
   }],
 
   invalid: [{
@@ -129,5 +140,19 @@ ruleTester.run('react-require-optimization', rule, {
     }],
     parser: 'babel-eslint',
     parserOptions: parserOptions
+  }, {
+    code: [
+      '@bar',
+      '@pure',
+      '@foo',
+      'class DecoratedComponent extends Component {' +
+      '}'
+    ].join('\n'),
+    errors: [{
+      message: MESSAGE
+    }],
+    parser: 'babel-eslint',
+    options: [{allowDecorators: ['renderPure', 'pureRender']}],
+    parserOptions: parserOptions
   }]
 });