Skip to content
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

Make no-danger-with-children deal with props that are variables (Fixes #767) #768

Merged
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
78 changes: 53 additions & 25 deletions lib/rules/no-danger-with-children.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@
*/
'use strict';

var variableUtil = require('../util/variable');

// ------------------------------------------------------------------------------
// Rule Definition
// ------------------------------------------------------------------------------
Expand All @@ -17,31 +19,53 @@ module.exports = {
schema: [] // no options
},
create: function(context) {
/**
* Takes a ObjectExpression and returns the value of the prop if it has it
* @param {object} node - ObjectExpression node
* @param {string} propName - name of the prop to look for
*/
function findObjectProp(node, propName) {
return node.properties.find(function(prop) {
return prop.key.name === propName;
});
}

/**
* Takes a JSXElement and returns the value of the prop if it has it
* @param {object} node - JSXElement node
* @param {string} propName - name of the prop to look for
*/
function findJsxProp(node, propName) {
var attributes = node.openingElement.attributes;
return attributes.find(function (attribute) {
if (attribute.type === 'JSXSpreadAttribute') {
var variable = variableUtil.variablesInScope(context).find(function (item) {
return item.name === attribute.argument.name;
});
if (variable && variable.defs[0].node.init) {
return findObjectProp(variable.defs[0].node.init, propName);
}
}
return attribute.name && attribute.name.name === propName;
});
}

return {
JSXElement: function (node) {
var hasChildren = false;
var attributes = node.openingElement.attributes;

if (node.children.length) {
hasChildren = true;
} else {
var childrenProp = attributes.find(function (attribute) {
return attribute.name.name === 'children';
});
if (childrenProp) {
hasChildren = true;
}
} else if (findJsxProp(node, 'children')) {
hasChildren = true;
}

if (attributes && hasChildren) {
var jsxElement = attributes.find(function (attribute) {
return attribute.name.name === 'dangerouslySetInnerHTML';
});


if (jsxElement) {
context.report(node, 'Only set one of `children` or `props.dangerouslySetInnerHTML`');
}
if (
node.openingElement.attributes
&& hasChildren
&& findJsxProp(node, 'dangerouslySetInnerHTML')
) {
context.report(node, 'Only set one of `children` or `props.dangerouslySetInnerHTML`');
}
},
CallExpression: function (node) {
Expand All @@ -53,17 +77,21 @@ module.exports = {
) {
var hasChildren = false;

var props = node.arguments[1].properties;
var dangerously = props.find(function(prop) {
return prop.key.name === 'dangerouslySetInnerHTML';
});
var props = node.arguments[1];

if (props.type === 'Identifier') {
var variable = variableUtil.variablesInScope(context).find(function (item) {
return item.name === props.name;
});
if (variable && variable.defs[0].node.init) {
props = variable.defs[0].node.init;
}
}

var dangerously = findObjectProp(props, 'dangerouslySetInnerHTML');

if (node.arguments.length === 2) {
var childrenProp = props.find(function(prop) {
return prop.key.name === 'children';
});
if (childrenProp) {
if (findObjectProp(props, 'children')) {
hasChildren = true;
}
} else {
Expand Down
51 changes: 51 additions & 0 deletions tests/lib/rules/no-danger-with-children.js
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,24 @@ ruleTester.run('no-danger-with-children', rule, {
code: '<div dangerouslySetInnerHTML={{ __html: "HTML" }} />',
parserOptions: parserOptions
},
{
code: '<div children="Children" />',
parserOptions: parserOptions
},
{
code: [
'const props = { dangerouslySetInnerHTML: { __html: "HTML" } };',
'<div {...props} />'
].join('\n'),
parserOptions: parserOptions
},
{
code: [
'const props = { children: "Children" };',
'<div {...props} />'
].join('\n'),
parserOptions: parserOptions
},
{
code: '<Hello>Children</Hello>',
parserOptions: parserOptions
Expand Down Expand Up @@ -73,6 +91,23 @@ ruleTester.run('no-danger-with-children', rule, {
errors: [{message: 'Only set one of `children` or `props.dangerouslySetInnerHTML`'}],
parserOptions: parserOptions
},
{
code: [
'const props = { dangerouslySetInnerHTML: { __html: "HTML" } };',
'<div {...props}>Children</div>'
].join('\n'),
errors: [{message: 'Only set one of `children` or `props.dangerouslySetInnerHTML`'}],
parserOptions: parserOptions
},
{
code: [
'const props = { children: "Children", dangerouslySetInnerHTML: { __html: "HTML" } };',
'<div {...props} />',
'//foobar'
].join('\n'),
errors: [{message: 'Only set one of `children` or `props.dangerouslySetInnerHTML`'}],
parserOptions: parserOptions
},
{
code: [
'<Hello dangerouslySetInnerHTML={{ __html: "HTML" }}>',
Expand Down Expand Up @@ -134,6 +169,22 @@ ruleTester.run('no-danger-with-children', rule, {
].join('\n'),
errors: [{message: 'Only set one of `children` or `props.dangerouslySetInnerHTML`'}],
parserOptions: parserOptions
},
{
code: [
'const props = { dangerouslySetInnerHTML: { __html: "HTML" } };',
'React.createElement("div", props, "Children");'
].join('\n'),
errors: [{message: 'Only set one of `children` or `props.dangerouslySetInnerHTML`'}],
parserOptions: parserOptions
},
{
code: [
'const props = { children: "Children", dangerouslySetInnerHTML: { __html: "HTML" } };',
'React.createElement("div", props);'
].join('\n'),
errors: [{message: 'Only set one of `children` or `props.dangerouslySetInnerHTML`'}],
parserOptions: parserOptions
}
]
});