the-forest/client/node_modules/eslint-plugin-react/lib/rules/style-prop-object.js

146 lines
4.0 KiB
JavaScript
Raw Normal View History

2024-09-17 20:35:18 -04:00
/**
* @fileoverview Enforce style prop value is an object
* @author David Petersen
*/
'use strict';
const variableUtil = require('../util/variable');
const docsUrl = require('../util/docsUrl');
const isCreateElement = require('../util/isCreateElement');
const report = require('../util/report');
// ------------------------------------------------------------------------------
// Rule Definition
// ------------------------------------------------------------------------------
const messages = {
stylePropNotObject: 'Style prop value must be an object',
};
/** @type {import('eslint').Rule.RuleModule} */
module.exports = {
meta: {
docs: {
description: 'Enforce style prop value is an object',
category: 'Possible Errors',
recommended: false,
url: docsUrl('style-prop-object'),
},
messages,
schema: [
{
type: 'object',
properties: {
allow: {
type: 'array',
items: {
type: 'string',
},
additionalItems: false,
uniqueItems: true,
},
},
},
],
},
create(context) {
const allowed = new Set(((context.options.length > 0) && context.options[0].allow) || []);
/**
* @param {ASTNode} expression An Identifier node
* @returns {boolean}
*/
function isNonNullaryLiteral(expression) {
return expression.type === 'Literal' && expression.value !== null;
}
/**
* @param {object} node A Identifier node
*/
function checkIdentifiers(node) {
const variable = variableUtil.getVariableFromContext(context, node, node.name);
if (!variable || !variable.defs[0] || !variable.defs[0].node.init) {
return;
}
if (isNonNullaryLiteral(variable.defs[0].node.init)) {
report(context, messages.stylePropNotObject, 'stylePropNotObject', {
node,
});
}
}
return {
CallExpression(node) {
if (
isCreateElement(context, node)
&& node.arguments.length > 1
) {
if ('name' in node.arguments[0] && node.arguments[0].name) {
// store name of component
const componentName = node.arguments[0].name;
// allowed list contains the name
if (allowed.has(componentName)) {
// abort operation
return;
}
}
if (node.arguments[1].type === 'ObjectExpression') {
const style = node.arguments[1].properties.find((property) => (
'key' in property
&& property.key
&& 'name' in property.key
&& property.key.name === 'style'
&& !property.computed
));
if (style && 'value' in style) {
if (style.value.type === 'Identifier') {
checkIdentifiers(style.value);
} else if (isNonNullaryLiteral(style.value)) {
report(context, messages.stylePropNotObject, 'stylePropNotObject', {
node: style.value,
});
}
}
}
}
},
JSXAttribute(node) {
if (!node.value || node.name.name !== 'style') {
return;
}
// store parent element
const parentElement = node.parent;
// parent element is a JSXOpeningElement
if (parentElement && parentElement.type === 'JSXOpeningElement') {
// get the name of the JSX element
const name = parentElement.name && parentElement.name.name;
// allowed list contains the name
if (allowed.has(name)) {
// abort operation
return;
}
}
if (node.value.type !== 'JSXExpressionContainer' || isNonNullaryLiteral(node.value.expression)) {
report(context, messages.stylePropNotObject, 'stylePropNotObject', {
node,
});
} else if (node.value.expression.type === 'Identifier') {
checkIdentifiers(node.value.expression);
}
},
};
},
};