Skip to content

Commit

Permalink
Detect import and require of PropTypes
Browse files Browse the repository at this point in the history 
(rebased)
  • Loading branch information
@brettdh @ljharb
brettdh authored and ljharb committed Feb 1, 2018
1 parent 0e1009d commit 4abebc3
Show file tree
Hide file tree
Showing 2 changed files with 188 additions and 56 deletions.
38 changes: 33 additions & 5 deletions lib/rules/no-typos.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,8 @@ module.exports = {
},

create: Components.detect((context, components, utils) => {
let propTypesPackageName;

function checkValidPropTypeQualfier(node) {
if (node.name !== 'isRequired') {
context.report({
Expand All @@ -56,14 +58,28 @@ module.exports = {

/* eslint-disable no-use-before-define */
function checkValidProp(node) {
if (node && node.type === 'MemberExpression' && node.object.type === 'MemberExpression') {
if (!propTypesPackageName || !node) {
return;
}

if (
node.type === 'MemberExpression' &&
node.object.type === 'MemberExpression' &&
node.object.object.name === propTypesPackageName
) { // PropTypes.myProp.isRequired
checkValidPropType(node.object.property);
checkValidPropTypeQualfier(node.property);
} else if (node && node.type === 'MemberExpression' && node.object.type === 'Identifier' && node.property.name !== 'isRequired') {
} else if (
node.type === 'MemberExpression' &&
node.object.type === 'Identifier' &&
node.object.name === propTypesPackageName &&
node.property.name !== 'isRequired'
) { // PropTypes.myProp
checkValidPropType(node.property);
} else if (node && (
node.type === 'MemberExpression' && node.object.type === 'CallExpression' || node.type === 'CallExpression'
)) {
} else if (
(node.type === 'MemberExpression' && node.object.type === 'CallExpression') ||
node.type === 'CallExpression'
) { // Shapes
if (node.type === 'MemberExpression') {
checkValidPropTypeQualfier(node.property);
node = node.object;
Expand Down Expand Up @@ -113,6 +129,18 @@ module.exports = {
}

return {
ImportDeclaration: function(node) {
if (node.source && node.source.value === 'prop-types') { // import PropType from "prop-types"
propTypesPackageName = node.specifiers[0].local.name;
}
},

CallExpression: function(node) {
if (node.callee.name === 'require' && node.arguments[0].value === 'prop-types') {
propTypesPackageName = node.parent.id.name;
}
},

ClassProperty: function(node) {
if (!node.static || !utils.isES6Component(node.parent.parent)) {
return;
Expand Down
206 changes: 155 additions & 51 deletions tests/lib/rules/no-typos.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -260,81 +260,134 @@ ruleTester.run('no-typos', rule, {
parser: 'babel-eslint',
parserOptions: parserOptions
}, {
code: `class Component extends React.Component {};
Component.propTypes = {
a: PropTypes.number.isRequired
}
code: `
import PropTypes from "prop-types";
class Component extends React.Component {};
Component.propTypes = {
a: PropTypes.number.isRequired
}
`,
parser: 'babel-eslint',
parserOptions: parserOptions
}, {
code: `class Component extends React.Component {};
Component.propTypes = {
e: PropTypes.shape({
ea: PropTypes.string,
})
}
code: `
import PropTypes from "prop-types";
class Component extends React.Component {};
Component.propTypes = {
e: PropTypes.shape({
ea: PropTypes.string,
})
}
`,
parser: 'babel-eslint',
parserOptions: parserOptions
}, {
code: `class Component extends React.Component {};
Component.propTypes = {
a: PropTypes.string,
b: PropTypes.string.isRequired,
c: PropTypes.shape({
d: PropTypes.string,
e: PropTypes.number.isRequired,
}).isRequired
}
code: `
import PropTypes from "prop-types";
class Component extends React.Component {};
Component.propTypes = {
a: PropTypes.string,
b: PropTypes.string.isRequired,
c: PropTypes.shape({
d: PropTypes.string,
e: PropTypes.number.isRequired,
}).isRequired
}
`,
parser: 'babel-eslint',
parserOptions: parserOptions
}, {
code: `class Component extends React.Component {};
Component.propTypes = {
a: PropTypes.oneOfType([
PropTypes.string,
PropTypes.number
])
}
code: `
import PropTypes from "prop-types";
class Component extends React.Component {};
Component.propTypes = {
a: PropTypes.oneOfType([
PropTypes.string,
PropTypes.number
])
}
`,
parser: 'babel-eslint',
parserOptions: parserOptions
}, {
code: `class Component extends React.Component {};
Component.propTypes = {
a: PropTypes.oneOf([
'hello',
'hi'
])
}
code: `
import PropTypes from "prop-types";
class Component extends React.Component {};
Component.propTypes = {
a: PropTypes.oneOf([
'hello',
'hi'
])
}
`,
parser: 'babel-eslint',
parserOptions: parserOptions
}, {
code: `class Component extends React.Component {};
Component.childContextTypes = {
a: PropTypes.string,
b: PropTypes.string.isRequired,
c: PropTypes.shape({
d: PropTypes.string,
e: PropTypes.number.isRequired,
}).isRequired
}
code: `
import PropTypes from "prop-types";
class Component extends React.Component {};
Component.childContextTypes = {
a: PropTypes.string,
b: PropTypes.string.isRequired,
c: PropTypes.shape({
d: PropTypes.string,
e: PropTypes.number.isRequired,
}).isRequired
}
`,
parser: 'babel-eslint',
parserOptions: parserOptions
}, {
code: `class Component extends React.Component {};
Component.contextTypes = {
a: PropTypes.string,
b: PropTypes.string.isRequired,
c: PropTypes.shape({
d: PropTypes.string,
e: PropTypes.number.isRequired,
}).isRequired
}
code: `
import PropTypes from "prop-types";
class Component extends React.Component {};
Component.contextTypes = {
a: PropTypes.string,
b: PropTypes.string.isRequired,
c: PropTypes.shape({
d: PropTypes.string,
e: PropTypes.number.isRequired,
}).isRequired
}
`,
parser: 'babel-eslint',
parserOptions: parserOptions
}, {
code: `
import PropTypes from 'prop-types'
import * as MyPropTypes from 'lib/my-prop-types'
class Component extends React.Component {};
Component.propTypes = {
a: PropTypes.string,
b: MyPropTypes.MYSTRING,
c: MyPropTypes.MYSTRING.isRequired,
}
`,
parser: 'babel-eslint',
parserOptions: parserOptions
}, {
code: `
const PropTypes = require('prop-types');
const MyPropTypes = require('lib/my-prop-types')
class Component extends React.Component {};
Component.propTypes = {
a: PropTypes.string,
b: MyPropTypes.MYSTRING,
c: MyPropTypes.MYSTRING.isRequired,
}
`,
parser: 'babel-eslint',
parserOptions: parserOptions
}, {
code: `
const RealPropTypes = require('prop-types');
const MyPropTypes = require('lib/my-prop-types')
class Component extends React.Component {};
Component.propTypes = {
a: RealPropTypes.string,
b: MyPropTypes.MYSTRING,
c: MyPropTypes.MYSTRING.isRequired,
}
`,
parser: 'babel-eslint',
parserOptions: parserOptions
Expand Down Expand Up @@ -710,6 +763,7 @@ ruleTester.run('no-typos', rule, {
}]
}, {
code: `
import PropTypes from "prop-types";
class Component extends React.Component {};
Component.propTypes = {
a: PropTypes.Number.isRequired
Expand All @@ -722,6 +776,7 @@ ruleTester.run('no-typos', rule, {
}]
}, {
code: `
import PropTypes from "prop-types";
class Component extends React.Component {};
Component.propTypes = {
a: PropTypes.number.isrequired
Expand All @@ -734,6 +789,7 @@ ruleTester.run('no-typos', rule, {
}]
}, {
code: `
import PropTypes from "prop-types";
class Component extends React.Component {};
Component.propTypes = {
a: PropTypes.Number
Expand All @@ -746,6 +802,7 @@ ruleTester.run('no-typos', rule, {
}]
}, {
code: `
import PropTypes from "prop-types";
class Component extends React.Component {};
Component.propTypes = {
a: PropTypes.shape({
Expand All @@ -761,6 +818,7 @@ ruleTester.run('no-typos', rule, {
}]
}, {
code: `
import PropTypes from "prop-types";
class Component extends React.Component {};
Component.propTypes = {
a: PropTypes.oneOfType([
Expand All @@ -776,6 +834,7 @@ ruleTester.run('no-typos', rule, {
}]
}, {
code: `
import PropTypes from "prop-types";
class Component extends React.Component {};
Component.propTypes = {
a: PropTypes.bools,
Expand All @@ -797,6 +856,29 @@ ruleTester.run('no-typos', rule, {
}]
}, {
code: `
import PropTypes from "prop-types";
class Component extends React.Component {};
Component.childContextTypes = {
a: PropTypes.bools,
b: PropTypes.Array,
c: PropTypes.function,
d: PropTypes.objectof,
}
`,
parser: 'babel-eslint',
parserOptions: parserOptions,
errors: [{
message: 'Typo in declared prop type: bools'
}, {
message: 'Typo in declared prop type: Array'
}, {
message: 'Typo in declared prop type: function'
}, {
message: 'Typo in declared prop type: objectof'
}]
}, {
code: `
const PropTypes = require('prop-types');
class Component extends React.Component {};
Component.childContextTypes = {
a: PropTypes.bools,
Expand Down Expand Up @@ -847,5 +929,27 @@ ruleTester.run('no-typos', rule, {
}, {
message: 'Typo in prop type chain qualifier: isrequired'
}]
}, {
code: `
const RealPropTypes = require('prop-types');
class Component extends React.Component {};
Component.childContextTypes = {
a: RealPropTypes.bools,
b: RealPropTypes.Array,
c: RealPropTypes.function,
d: RealPropTypes.objectof,
}
`,
parser: 'babel-eslint',
parserOptions: parserOptions,
errors: [{
message: 'Typo in declared prop type: bools'
}, {
message: 'Typo in declared prop type: Array'
}, {
message: 'Typo in declared prop type: function'
}, {
message: 'Typo in declared prop type: objectof'
}]
}]
});

0 comments on commit 4abebc3

Please sign in to comment.