Skip to content

Fix prop-types desctructuring with properties as string. #124

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 19, 2015
Merged

Fix prop-types desctructuring with properties as string. #124

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 20 additions & 8 deletions lib/rules/prop-types.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -164,6 +164,16 @@ module.exports = function(context) {
return tokens.length && tokens[0].value === '...';
}

function getKeyValue(node) {
var key = node.key;
if (key) {
if (key.type === 'Identifier') {
return key.name;
}
return key.value;
}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why not

return (key.type === 'Identifier') ? key.name : key.value;

here https://github.com/yannickcr/eslint-plugin-react/pull/123/files#diff-6149d4075a6f3125f18ce8c87bb253cbR39 you've done it like that:

return node.key.type === 'Identifier' ? node.key.name : node.key.value;

Of course it is just a matter of taste 🍒

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The difference is that in jsx-sort-prop-types it only checks the propTypes declaration and not its uses.
I was thinking (though I didn't implement it yet) that when checking the uses, you could have the case const aria = this.props["aria-controls"];. Right now, this is ignored by the rule because it's a "computed" property. However, I could easily inspect that property, realize it's a literal string value and add the check (there are other implications which is why I haven't done it yet, mostly with case this.props["some.thing"] and name.split(".") in the rule).
Therefore, I left it with that structure to make it easy to add more checks.
Note that it's possible, but make no sense to do propType: {["aria-controls"]: React.PropTypes.string}; So they are deliberately ignored in the other rule.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yep, there is really a lot of different ways to declare/use propTypes, it become hard to check all of them.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for the explanation 🍒 😃

}

/**
* Iterates through a properties node, like a customized forEach.
* @param {Object[]} properties Array of properties to iterate.
Expand All @@ -174,11 +184,10 @@ module.exports = function(context) {
if (properties.length && typeof fn === 'function') {
for (var i = 0, j = properties.length; i < j; i++) {
var node = properties[i];
var key = node.key;
var keyName = key.type === 'Identifier' ? key.name : key.value;
var key = getKeyValue(node);

var value = node.value;
fn(keyName, value);
fn(key, value);
}
}
}
Expand Down Expand Up @@ -331,7 +340,7 @@ module.exports = function(context) {
} else if (
node.parent.parent.declarations &&
node.parent.parent.declarations[0].id.properties &&
node.parent.parent.declarations[0].id.properties[0].key.name
getKeyValue(node.parent.parent.declarations[0].id.properties[0])
) {
type = 'destructuring';
}
Expand All @@ -355,10 +364,13 @@ module.exports = function(context) {
if (hasSpreadOperator(properties[i])) {
continue;
}
usedPropTypes.push({
name: properties[i].key.name,
node: properties[i]
});
var propName = getKeyValue(properties[i]);
if (propName) {
usedPropTypes.push({
name: propName,
node: properties[i]
});
}
}
break;
default:
Expand Down
36 changes: 36 additions & 0 deletions tests/lib/rules/prop-types.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -415,6 +415,23 @@ eslintTester.addRuleTest('lib/rules/prop-types', {
classes: true,
jsx: true
}
}, {
code: [
'class Hello extends React.Component {',
' render() {',
' var { ',
' propX,',
' "aria-controls": ariaControls, ',
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 😄

' ...props } = this.props;',
' return <div>Hello</div>;',
' }',
'}',
'Hello.propTypes = {',
' "propX": React.PropTypes.string,',
' "aria-controls": React.PropTypes.string',
'};'
].join('\n'),
parser: 'babel-eslint'
}
],

Expand Down Expand Up @@ -719,6 +736,25 @@ eslintTester.addRuleTest('lib/rules/prop-types', {
{message: '\'numb.propX\' is missing in props validation for Hello'},
{message: '\'stri.tooString\' is missing in props validation for Hello'}
]
}, {
code: [
'class Hello extends React.Component {',
' render() {',
' var { ',
' "aria-controls": ariaControls, ',
' propX,',
' ...props } = this.props;',
' return <div>Hello</div>;',
' }',
'}',
'Hello.propTypes = {',
' "aria-controls": React.PropTypes.string',
'};'
].join('\n'),
parser: 'babel-eslint',
errors: [
{message: '\'propX\' is missing in props validation for Hello'}
]
}
]
});