Merge pull request #160 from CalebMorris/customValidatorDetection

Add customValidators option to prop-types (fixes #145)

Author: yannickcr

lib/rules/prop-types.js

@@ -18,6 +18,7 @@ module.exports = function(context) {
 
   var configuration = context.options[0] || {};
   var ignored = configuration.ignore || [];
+  var customValidators = configuration.customValidators || [];
 
   var componentList = new ComponentList();
 
@@ -72,6 +73,15 @@ module.exports = function(context) {
     return ignored.indexOf(name) !== -1;
   }
 
+  /**
+   * Checks if prop should be validated by plugin-react-proptypes
+   * @param {String} validator Name of validator to check.
+   * @returns {Boolean} True if validator should be checked by custom validator.
+   */
+  function hasCustomValidator(validator) {
+    return customValidators.indexOf(validator) !== -1;
+  }
+
   /**
    * Checks if the component must be validated
    * @param {Object} component The component to process
@@ -203,6 +213,15 @@ module.exports = function(context) {
    *    the property is declared without the need for further analysis.
    */
   function buildReactDeclarationTypes(value) {
+    if (
+      value &&
+      value.callee &&
+      value.callee.object &&
+      hasCustomValidator(value.callee.object.name)
+    ) {
+      return true;
+    }
+
     if (
       value.type === 'MemberExpression' &&
       value.property &&
@@ -610,6 +629,12 @@ module.exports.schema = [{
       items: {
         type: 'string'
       }
+    },
+    customValidators: {
+      type: 'array',
+      items: {
+        type: 'string'
+      }
     }
   },
   additionalProperties: false

tests/lib/rules/prop-types.js

@@ -597,6 +597,87 @@ eslintTester.addRuleTest('lib/rules/prop-types', {
         classes: true,
         jsx: true
       }
+    }, {
+      code: [
+        'var Hello = React.createClass({',
+        '  propTypes: {',
+        '    firstname: CustomValidator.string',
+        '  },',
+        '  render: function() {',
+        '    return <div>{this.props.firstname}</div>;',
+        '  }',
+        '});'
+      ].join('\n'),
+      args: [1, {customValidators: ['CustomValidator']}],
+      ecmaFeatures: {
+        jsx: true
+      }
+    }, {
+      code: [
+        'var Hello = React.createClass({',
+        '  propTypes: {',
+        '    outer: CustomValidator.shape({',
+        '      inner: CustomValidator.map',
+        '    })',
+        '  },',
+        '  render: function() {',
+        '    return <div>{this.props.outer.inner}</div>;',
+        '  }',
+        '});'
+      ].join('\n'),
+      args: [1, {customValidators: ['CustomValidator']}],
+      ecmaFeatures: {
+        jsx: true
+      }
+    }, {
+      code: [
+        'var Hello = React.createClass({',
+        '  propTypes: {',
+        '    outer: React.PropTypes.shape({',
+        '      inner: CustomValidator.string',
+        '    })',
+        '  },',
+        '  render: function() {',
+        '    return <div>{this.props.outer.inner}</div>;',
+        '  }',
+        '});'
+      ].join('\n'),
+      args: [1, {customValidators: ['CustomValidator']}],
+      ecmaFeatures: {
+        jsx: true
+      }
+    }, {
+      code: [
+        'var Hello = React.createClass({',
+        '  propTypes: {',
+        '    outer: CustomValidator.shape({',
+        '      inner: React.PropTypes.string',
+        '    })',
+        '  },',
+        '  render: function() {',
+        '    return <div>{this.props.outer.inner}</div>;',
+        '  }',
+        '});'
+      ].join('\n'),
+      args: [1, {customValidators: ['CustomValidator']}],
+      ecmaFeatures: {
+        jsx: true
+      }
+    }, {
+      code: [
+        'var Hello = React.createClass({',
+        '  propTypes: {',
+        '    name: React.PropTypes.string',
+        '  },',
+        '  render: function() {',
+        '    return <div>{this.props.name.get("test")}</div>;',
+        '  }',
+        '});'
+      ].join('\n'),
+      args: [1, {customValidators: ['CustomValidator']}],
+      ecmaFeatures: {
+        jsx: true
+      }
     }, {
       code: [
         'class Comp1 extends Component {',