Add ignore option to prop-types rule

Author: yannickcr

docs/rules/prop-types.md

@@ -51,3 +51,16 @@ var Hello = React.createClass({
   }
 });
 ```
+
+## Rule Options
+
+This rule can take one argument to ignore some specific props during validation.
+
+```
+...
+"prop-types": [<enabled>, { ignore: <ignore> }]
+...
+```
+
+* `enabled`: for enabling the rule. 0=off, 1=warn, 2=error. Defaults to 0.
+* `ignore`: optional array of props name to ignore during validation.

lib/rules/prop-types.js

@@ -13,6 +13,9 @@ var ComponentList = componentUtil.List;
 
 module.exports = function(context) {
 
+  var configuration = context.options[0] || {};
+  var ignored = configuration.ignore || [];
+
   var componentList = new ComponentList();
 
   var MISSING_MESSAGE = '\'{{name}}\' is missing in props validation';
@@ -42,6 +45,28 @@ module.exports = function(context) {
     );
   }
 
+  /**
+   * Checks if the prop is ignored
+   * @param {String} name Name of the prop to check.
+   * @returns {Boolean} True if the prop is ignored, false if not.
+   */
+  function isIgnored(name) {
+    return ignored.indexOf(name) !== -1;
+  }
+
+  /**
+   * Checks if the prop is declared
+   * @param {String} name Name of the prop to check.
+   * @param {Object} component The component to process
+   * @returns {Boolean} True if the prop is declared, false if not.
+   */
+  function isDeclaredInComponent(component, name) {
+    return (
+      component.declaredPropTypes &&
+      component.declaredPropTypes.indexOf(name) !== -1
+    );
+  }
+
   /**
    * Mark a prop type as used
    * @param {ASTNode} node The AST node being marked.
@@ -117,25 +142,22 @@ module.exports = function(context) {
 
   /**
    * Reports undeclared proptypes for a given component
-   * @param {Object} id The component to process
+   * @param {Object} component The component to process
    */
   function reportUndeclaredPropTypes(component) {
     if (!component || !component.usedPropTypes || component.ignorePropsValidation === true) {
       return;
     }
+    var name;
     for (var i = 0, j = component.usedPropTypes.length; i < j; i++) {
-      var isDeclared =
-        component.declaredPropTypes &&
-        component.declaredPropTypes.indexOf(component.usedPropTypes[i].name) !== -1
-      ;
-      var isChildren = component.usedPropTypes[i].name === 'children';
-      if (isDeclared || isChildren) {
+      name = component.usedPropTypes[i].name;
+      if (isDeclaredInComponent(component, name) || isIgnored(name)) {
         continue;
       }
       context.report(
         component.usedPropTypes[i].node,
         component.name === componentUtil.DEFAULT_COMPONENT_NAME ? MISSING_MESSAGE : MISSING_MESSAGE_NAMED_COMP, {
-          name: component.usedPropTypes[i].name,
+          name: name,
           component: component.name
         }
       );

tests/lib/rules/prop-types.js

@@ -66,6 +66,9 @@ eslintTester.addRuleTest('lib/rules/prop-types', {
         '  }',
         '});'
       ].join('\n'),
+      args: [1, {
+        ignore: ['children']
+      }],
       ecmaFeatures: {
         jsx: true
       }