Documentation

Author: Evgueni Naverniouk

README.md

@@ -95,6 +95,7 @@ The plugin has a [recommended configuration](#user-content-recommended-configura
 * [self-closing-comp](docs/rules/self-closing-comp.md): Prevent extra closing tags for components without children
 * [sort-comp](docs/rules/sort-comp.md): Enforce component methods order
 * [sort-prop-types](docs/rules/sort-prop-types.md): Enforce propTypes declarations alphabetical sorting
+* [unused-prop-types](docs/rules/unused-prop-types.md): Prevent definitions of unused prop types 
 * [wrap-multilines](docs/rules/wrap-multilines.md): Prevent missing parentheses around multilines JSX (fixable)
 
 ## JSX-specific rules

docs/rules/unused-prop-types.md

@@ -0,0 +1,69 @@
+# Prevent definitions of unused prop types (unused-prop-types)
+
+Warns you if you have defined a prop type but it is never being used anywhere.
+
+## Rule Details
+
+The following patterns are considered warnings:
+
+```jsx
+var Hello = React.createClass({
+  propTypes: {
+    name: React.PropTypes.string
+  },
+  render: function() {
+    return <div>Hello Bob</div>;
+  }
+});
+
+var Hello = React.createClass({
+  propTypes: {
+    firstname: React.PropTypes.string.isRequired,
+    middlename: React.PropTypes.string.isRequired, // middlename is never used below
+	lastname: React.PropTypes.string.isRequired
+  },
+  render: function() {
+    return <div>Hello {this.props.firstname} {this.props.lastname}</div>;
+  }
+});
+
+function Hello({ name }) {
+  return <div>Hello Jeremy</div>;
+}
+```
+
+The following patterns are not considered warnings:
+
+```jsx
+var Hello = React.createClass({
+  propTypes: {
+    name: React.PropTypes.string
+  },
+  render: function() {
+    return <div>Hello {this.props.name}</div>;
+  }
+});
+```
+
+## Rule Options
+
+This rule can take one argument to ignore some specific props during validation.
+
+```
+...
+"prop-types": [<enabled>, { customValidators: <customValidator> }]
+...
+```
+
+* `enabled`: for enabling the rule. 0=off, 1=warn, 2=error. Defaults to 0.
+* `customValidators`: optional array of validators used for propTypes validation.
+
+## About component detection
+
+For this rule to work we need to detect React components, this could be very hard since components could be declared in a lot of ways.
+
+For now we should detect components created with:
+
+* `React.createClass()`
+* an ES6 class that inherit from `React.Component` or `Component`
+* a stateless function that return JSX or the result of a `React.createElement` call.

lib/rules/unused-prop-types.js

@@ -1,5 +1,5 @@
 /**
- * @fileoverview Warn about unused PropType definitions in React components
+ * @fileoverview Prevent definitions of unused prop types
  * @author Evgueni Naverniouk
  */
 'use strict';