96 lines
2.5 KiB
JavaScript
96 lines
2.5 KiB
JavaScript
|
/**
|
||
|
|
* @fileoverview Prevent usage of dangerous JSX props
|
||
|
|
* @author Scott Andrews
|
||
|
|
*/
|
||
|
|
|
||
|
|
'use strict';
|
||
|
|
|
||
|
|
const has = require('hasown');
|
||
|
|
const fromEntries = require('object.fromentries/polyfill')();
|
||
|
|
const minimatch = require('minimatch');
|
||
|
|
|
||
|
|
const docsUrl = require('../util/docsUrl');
|
||
|
|
const jsxUtil = require('../util/jsx');
|
||
|
|
const report = require('../util/report');
|
||
|
|
|
||
|
|
// ------------------------------------------------------------------------------
|
||
|
|
// Constants
|
||
|
|
// ------------------------------------------------------------------------------
|
||
|
|
|
||
|
|
const DANGEROUS_PROPERTY_NAMES = [
|
||
|
|
'dangerouslySetInnerHTML',
|
||
|
|
];
|
||
|
|
|
||
|
|
const DANGEROUS_PROPERTIES = fromEntries(DANGEROUS_PROPERTY_NAMES.map((prop) => [prop, prop]));
|
||
|
|
|
||
|
|
// ------------------------------------------------------------------------------
|
||
|
|
// Helpers
|
||
|
|
// ------------------------------------------------------------------------------
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Checks if a JSX attribute is dangerous.
|
||
|
|
* @param {string} name - Name of the attribute to check.
|
||
|
|
* @returns {boolean} Whether or not the attribute is dangerous.
|
||
|
|
*/
|
||
|
|
function isDangerous(name) {
|
||
|
|
return has(DANGEROUS_PROPERTIES, name);
|
||
|
|
}
|
||
|
|
|
||
|
|
// ------------------------------------------------------------------------------
|
||
|
|
// Rule Definition
|
||
|
|
// ------------------------------------------------------------------------------
|
||
|
|
|
||
|
|
const messages = {
|
||
|
|
dangerousProp: 'Dangerous property \'{{name}}\' found',
|
||
|
|
};
|
||
|
|
|
||
|
|
/** @type {import('eslint').Rule.RuleModule} */
|
||
|
|
module.exports = {
|
||
|
|
meta: {
|
||
|
|
docs: {
|
||
|
|
description: 'Disallow usage of dangerous JSX properties',
|
||
|
|
category: 'Best Practices',
|
||
|
|
recommended: false,
|
||
|
|
url: docsUrl('no-danger'),
|
||
|
|
},
|
||
|
|
|
||
|
|
messages,
|
||
|
|
|
||
|
|
schema: [{
|
||
|
|
type: 'object',
|
||
|
|
properties: {
|
||
|
|
customComponentNames: {
|
||
|
|
items: {
|
||
|
|
type: 'string',
|
||
|
|
},
|
||
|
|
minItems: 0,
|
||
|
|
type: 'array',
|
||
|
|
uniqueItems: true,
|
||
|
|
},
|
||
|
|
},
|
||
|
|
}],
|
||
|
|
},
|
||
|
|
|
||
|
|
create(context) {
|
||
|
|
const configuration = context.options[0] || {};
|
||
|
|
const customComponentNames = configuration.customComponentNames || [];
|
||
|
|
|
||
|
|
return {
|
||
|
|
JSXAttribute(node) {
|
||
|
|
const functionName = node.parent.name.name;
|
||
|
|
|
||
|
|
const enableCheckingCustomComponent = customComponentNames.some((name) => minimatch(functionName, name));
|
||
|
|
|
||
|
|
if ((enableCheckingCustomComponent || jsxUtil.isDOMComponent(node.parent)) && isDangerous(node.name.name)) {
|
||
|
|
report(context, messages.dangerousProp, 'dangerousProp', {
|
||
|
|
node,
|
||
|
|
data: {
|
||
|
|
name: node.name.name,
|
||
|
|
},
|
||
|
|
});
|
||
|
|
}
|
||
|
|
},
|
||
|
|
};
|
||
|
|
},
|
||
|
|
};
|