Skip to content

Handle isRequired for boolean-prop-naming #1701

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.

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
Feb 23, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
9 changes: 7 additions & 2 deletions lib/rules/boolean-prop-naming.js
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,8 @@ module.exports = {
* propTypes: {
* full: React.PropTypes.bool,
* short: PropTypes.bool,
* direct: bool
* direct: bool,
* required: PropTypes.bool.isRequired
* }
* @param {Object} node The node we're getting the name of
*/
Expand All @@ -73,7 +74,11 @@ module.exports = {
return null;
}
if (node.value.property) {
return node.value.property.name;
const name = node.value.property.name;
if (name === 'isRequired') {
return node.value.object.property.name;
}
return name;
}
if (node.value.type === 'Identifier') {
return node.value.name;
Expand Down
98 changes: 98 additions & 0 deletions tests/lib/rules/boolean-prop-naming.js
Original file line number Diff line number Diff line change
Expand Up @@ -307,6 +307,47 @@ ruleTester.run('boolean-prop-naming', rule, {
options: [{
rule: '^(is|has)[A-Z]([A-Za-z0-9]?)+'
}]
}, {
// Ensure the rule does not throw when a prop isRequired when ES5.
code: `
var Hello = createReactClass({
propTypes: {isSomething: PropTypes.bool.isRequired, hasValue: PropTypes.bool.isRequired},
render: function() { return <div />; }
});
`
}, {
// Ensure the rule does not throw when a prop isRequired when ES6 with static properties.
code: `
class Hello extends React.Component {
static propTypes = {
isSomething: PropTypes.bool.isRequired,
hasValue: PropTypes.bool.isRequired
};

render() {
return (
<div />
);
}
}
`,
parser: 'babel-eslint'
}, {
// Ensure the rule does not throw when a prop isRequired when ES6 without static properties.
code: `
class Hello extends React.Component {
render() {
return (
<div />
);
}
}

Hello.propTypes = {
isSomething: PropTypes.bool.isRequired,
hasValue: PropTypes.bool.isRequired
}
`
}],

invalid: [{
Expand Down Expand Up @@ -664,5 +705,62 @@ ruleTester.run('boolean-prop-naming', rule, {
errors: [{
message: 'It is better if your prop (something) matches this pattern: (^is[A-Z]([A-Za-z0-9]?)+)'
}]
}, {
// Works when a prop isRequired in ES5.
code: `
var Hello = createReactClass({
propTypes: {something: PropTypes.bool.isRequired},
render: function() { return <div />; }
});
`,
options: [{
rule: '^is[A-Z]([A-Za-z0-9]?)+'
}],
errors: [{
message: 'Prop name (something) doesn\'t match rule (^is[A-Z]([A-Za-z0-9]?)+)'
}]
}, {
// Works when a prop isRequired in ES6 with static properties.
code: `
class Hello extends React.Component {
static propTypes = {
something: PropTypes.bool.isRequired
};

render() {
return (
<div />
);
}
}
`,
options: [{
rule: '^is[A-Z]([A-Za-z0-9]?)+'
}],
parser: 'babel-eslint',
errors: [{
message: 'Prop name (something) doesn\'t match rule (^is[A-Z]([A-Za-z0-9]?)+)'
}]
}, {
// Works when a prop isRequired in ES6 without static properties.
code: `
class Hello extends React.Component {
render() {
return (
<div />
);
}
}

Hello.propTypes = {
something: PropTypes.bool.isRequired
}
`,
options: [{
rule: '^is[A-Z]([A-Za-z0-9]?)+'
}],
errors: [{
message: 'Prop name (something) doesn\'t match rule (^is[A-Z]([A-Za-z0-9]?)+)'
}]
}]
});