Allow skipping prop-types validation when not declared #846
Conversation
Adding the `prop-types` rule can be a daunting task for projects that have not been consistent about using prop types to begin with. This allows users to slowly opt-in to prop-types validation by only erroring on "incomplete" propTypes declarations.
|
@ljharb sure thing - let me know if this is what you had in mind |
| }, { | ||
| code: [ | ||
| 'class Hello extends React.Component {', | ||
| ' static get propTypes() {', |
There was a problem hiding this comment.
actually this would be static propTypes = () => { - i don't think propTypes is expected to be anything but a data property.
There was a problem hiding this comment.
I copied how the other static propTypes were declared in this file. upon closer inspection, this file is inconsistent in how it declares static proptypes. I see three different types:
static get propTypes() {
static propTypes = {
static propTypes: {
do you think I should introduce a fourth type? i'm also happy to consolidate them but I think that is outside the scope of this PR
There was a problem hiding this comment.
Yes, I'm not sure why we have the getter version, and the "fourth" type is in fact the most standard. The third type there isn't actually valid because of the static keyword, but I think you mean its use in React.createClass, which is fine.
There was a problem hiding this comment.
Let's not worry about consolidating them in this PR, but please do add a Hello.propTypes = { … } variant.
| }, { | ||
| code: [ | ||
| 'class Hello extends React.Component {', | ||
| ' static get propTypes() {', |
There was a problem hiding this comment.
sure thing - I've added that as an additional case
| @@ -179,10 +182,12 @@ module.exports = { | |||
| * @returns {Boolean} True if the component must be validated, false if not. | |||
| */ | |||
| function mustBeValidated(component) { | |||
| var isSkippedByConfig = (typeof component.declaredPropTypes === 'undefined' && skipUndeclared); | |||
There was a problem hiding this comment.
These parens are unnecessary. It also might be better to check skipUndeclared first?
|
Merged, thanks! |
Adding the
prop-typesrule can be a daunting task forprojects that have not been consistent about using prop
types to begin with.
This allows users to slowly opt-in to prop-types validation
by only erroring on "incomplete" propTypes declarations.