forked from jsx-eslint/eslint-plugin-react
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add new dom-elements-style-is-object rule (Fixes jsx-eslint#715)
- Loading branch information
1 parent
1ab2eec
commit b0b6474
Showing
5 changed files
with
487 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,59 @@ | ||
# Enforce style prop value being an object (dom-elements-style-is-object) | ||
|
||
Require that the value of the prop `style` be an object or a variable that is | ||
an object. | ||
|
||
## Rule Details | ||
|
||
The property values of an object passed to the style prop must be strings. | ||
|
||
The following patterns are considered warnings: | ||
|
||
```jsx | ||
<div style="color: 'red'" /> | ||
|
||
<div style={true} /> | ||
|
||
<Hello style={true} /> | ||
|
||
const styles = true; | ||
<div style={styles} /> | ||
|
||
const styles = { height: 100 }; | ||
<div style={styles} /> | ||
``` | ||
|
||
```js | ||
React.createElement("div", { style: "color: 'red'" }); | ||
|
||
React.createElement("div", { style: true }); | ||
|
||
React.createElement("Hello", { style: true }); | ||
|
||
const styles = true; | ||
React.createElement("div", { style: styles }); | ||
|
||
const styles = { height: 100 }; | ||
React.createElement("div", { style: styles }); | ||
``` | ||
|
||
|
||
The following patterns are not considered warnings: | ||
|
||
```jsx | ||
<div style={{ color: "red" }} /> | ||
|
||
<Hello style={{ color: "red" }} /> | ||
|
||
const styles = { color: "red" }; | ||
<div style={styles} /> | ||
``` | ||
|
||
```js | ||
React.createElement("div", { style: { color: 'red' }}); | ||
|
||
React.createElement("Hello", { style: { color: 'red' }}); | ||
|
||
const styles = { height: '100px' }; | ||
React.createElement("div", { style: styles }); | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,100 @@ | ||
/** | ||
* @fileoverview Enforce style prop value being an object and havng sting values | ||
* @author David Petersen | ||
*/ | ||
'use strict'; | ||
|
||
var variableUtil = require('../util/variable'); | ||
|
||
// ------------------------------------------------------------------------------ | ||
// Rule Definition | ||
// ------------------------------------------------------------------------------ | ||
|
||
module.exports = { | ||
meta: { | ||
docs: { | ||
description: 'Enforce style prop value being an object and havng sting values', | ||
category: '', | ||
recommended: true | ||
}, | ||
schema: [] | ||
}, | ||
|
||
create: function(context) { | ||
/** | ||
* @param {object} node A ObjectExpression node | ||
*/ | ||
function checkValuesAreStrings(node) { | ||
node.properties.forEach(function(property) { | ||
if ( | ||
property.value.type !== 'Literal' | ||
|| typeof property.value.value !== 'string' | ||
) { | ||
context.report(property.value, 'Style object values must be strings'); | ||
} | ||
}); | ||
} | ||
|
||
/** | ||
* @param {object} node A Identifier node | ||
*/ | ||
function checkIdentifiers(node) { | ||
var variable = variableUtil.variablesInScope(context).find(function (item) { | ||
return item.name === node.name; | ||
}); | ||
|
||
if (!variable || !variable.defs[0].node.init) { | ||
return; | ||
} | ||
|
||
if (variable.defs[0].node.init.type === 'Literal') { | ||
context.report(node, 'Style prop value must be an object'); | ||
} else if (variable.defs[0].node.init.type === 'ObjectExpression') { | ||
checkValuesAreStrings(variable.defs[0].node.init); | ||
} | ||
} | ||
|
||
return { | ||
CallExpression: function(node) { | ||
if ( | ||
node.callee | ||
&& node.callee.type === 'MemberExpression' | ||
&& node.callee.property.name === 'createElement' | ||
&& node.arguments.length > 1 | ||
) { | ||
if (node.arguments[1].type === 'ObjectExpression') { | ||
var style = node.arguments[1].properties.find(function(property) { | ||
return property.key.name === 'style'; | ||
}); | ||
if (style) { | ||
if (style.value.type === 'Identifier') { | ||
checkIdentifiers(style.value); | ||
} else if (style.value.type === 'Literal') { | ||
context.report(style.value, 'Style prop value must be an object'); | ||
} else if (style.value.type === 'ObjectExpression') { | ||
checkValuesAreStrings(style.value); | ||
} | ||
} | ||
} | ||
} | ||
}, | ||
|
||
JSXAttribute: function(node) { | ||
if (node.name.name !== 'style') { | ||
return; | ||
} | ||
|
||
if ( | ||
node.value.type !== 'JSXExpressionContainer' | ||
|| node.value.expression.type === 'Literal' | ||
) { | ||
context.report(node, 'Style prop value must be an object'); | ||
} else if (node.value.expression.type === 'ObjectExpression') { | ||
checkValuesAreStrings(node.value.expression); | ||
} else if (node.value.expression.type === 'Identifier') { | ||
checkIdentifiers(node.value.expression); | ||
} | ||
} | ||
}; | ||
} | ||
}; |
Oops, something went wrong.