bloom-layout
Version:
layout components used in bloom packages
80 lines (66 loc) • 2.09 kB
JavaScript
/**
* @fileoverview Prevent usage of dangerous JSX props
* @author Scott Andrews
*/
;
const docsUrl = require('../util/docsUrl');
// ------------------------------------------------------------------------------
// Constants
// ------------------------------------------------------------------------------
const DANGEROUS_MESSAGE = 'Dangerous property \'{{name}}\' found';
const DANGEROUS_PROPERTY_NAMES = [
'dangerouslySetInnerHTML'
];
const DANGEROUS_PROPERTIES = DANGEROUS_PROPERTY_NAMES.reduce((props, prop) => {
props[prop] = prop;
return props;
}, Object.create(null));
// ------------------------------------------------------------------------------
// Helpers
// ------------------------------------------------------------------------------
/**
* Checks if a node name match the JSX tag convention.
* @param {String} name - Name of the node to check.
* @returns {boolean} Whether or not the node name match the JSX tag convention.
*/
const tagConvention = /^[a-z]|\-/;
function isTagName(name) {
return tagConvention.test(name);
}
/**
* Checks if a JSX attribute is dangerous.
* @param {String} name - Name of the attribute to check.
* @returns {boolean} Whether or not the attribute is dnagerous.
*/
function isDangerous(name) {
return name in DANGEROUS_PROPERTIES;
}
// ------------------------------------------------------------------------------
// Rule Definition
// ------------------------------------------------------------------------------
module.exports = {
meta: {
docs: {
description: 'Prevent usage of dangerous JSX props',
category: 'Best Practices',
recommended: false,
url: docsUrl('no-danger')
},
schema: []
},
create: function(context) {
return {
JSXAttribute: function(node) {
if (isTagName(node.parent.name.name) && isDangerous(node.name.name)) {
context.report({
node: node,
message: DANGEROUS_MESSAGE,
data: {
name: node.name.name
}
});
}
}
};
}
};