Add support for wrapped propTypes to sort-prop-types

jsx-eslint · Jun 24, 2017 · b25d791 · b25d791
1 parent b6e3a2f
commit b25d791
Show file tree

Hide file tree

Showing 2 changed files with 70 additions and 2 deletions.
diff --git a/lib/rules/sort-prop-types.js b/lib/rules/sort-prop-types.js
@@ -40,6 +40,7 @@ module.exports = {
     var requiredFirst = configuration.requiredFirst || false;
     var callbacksLast = configuration.callbacksLast || false;
     var ignoreCase = configuration.ignoreCase || false;
+    var propWrapperFunctions = new Set(context.settings.propWrapperFunctions || []);
 
     /**
      * Checks if node is `propTypes` declaration
@@ -144,8 +145,23 @@ module.exports = {
 
     return {
       ClassProperty: function(node) {
-        if (isPropTypesDeclaration(node) && node.value && node.value.type === 'ObjectExpression') {
-          checkSorted(node.value.properties);
+        if (!isPropTypesDeclaration(node)) {
+          return;
+        }
+        switch (node.value && node.value.type) {
+          case 'ObjectExpression':
+            checkSorted(node.value.properties);
+            break;
+          case 'CallExpression':
+            if (
+              propWrapperFunctions.has(node.value.callee.name) &&
+              node.value.arguments && node.value.arguments[0]
+            ) {
+              checkSorted(node.value.arguments[0].properties);
+            }
+            break;
+          default:
+            break;
         }
       },
 
@@ -156,6 +172,14 @@ module.exports = {
         var right = node.parent.right;
         var declarations;
         switch (right && right.type) {
+          case 'CallExpression':
+            if (
+              propWrapperFunctions.has(right.callee.name) &&
+              right.arguments && right.arguments[0]
+            ) {
+              declarations = right.arguments[0].properties;
+            }
+            break;
           case 'ObjectExpression':
             declarations = right.properties;
             break;

diff --git a/tests/lib/rules/sort-prop-types.js b/tests/lib/rules/sort-prop-types.js
@@ -449,6 +449,24 @@ ruleTester.run('sort-prop-types', rule, {
     ].join('\n'),
     parser: 'babel-eslint',
     errors: 2
+  }, {
+    code: [
+      'class Component extends React.Component {',
+      '  static propTypes = forbidExtraProps({',
+      '    z: PropTypes.any,',
+      '    y: PropTypes.any,',
+      '    a: PropTypes.any',
+      '  });',
+      '  render() {',
+      '    return <div />;',
+      '  }',
+      '}'
+    ].join('\n'),
+    parser: 'babel-eslint',
+    settings: {
+      propWrapperFunctions: ['forbidExtraProps']
+    },
+    errors: 2
   }, {
     code: [
       'var First = createReactClass({',
@@ -519,6 +537,32 @@ ruleTester.run('sort-prop-types', rule, {
       column: 5,
       type: 'Property'
     }]
+  }, {
+    code: [
+      'class First extends React.Component {',
+      '  render() {',
+      '    return <div />;',
+      '  }',
+      '}',
+      'First.propTypes = forbidExtraProps({',
+      '    a: PropTypes.any,',
+      '    z: PropTypes.string,',
+      '    onFoo: PropTypes.func,',
+      '    onBar: PropTypes.func',
+      '});'
+    ].join('\n'),
+    options: [{
+      callbacksLast: true
+    }],
+    settings: {
+      propWrapperFunctions: ['forbidExtraProps']
+    },
+    errors: [{
+      message: ERROR_MESSAGE,
+      line: 10,
+      column: 5,
+      type: 'Property'
+    }]
   }, {
     code: [
       'var First = createReactClass({',