github-pages-deploy-action/node_modules/eslint-plugin-react/lib/rules/forbid-dom-props.js

75 lines
1.7 KiB
JavaScript
Raw Normal View History

2020-03-07 11:45:40 +08:00
/**
* @fileoverview Forbid certain props on DOM Nodes
* @author David Vázquez
*/
'use strict';
const docsUrl = require('../util/docsUrl');
// ------------------------------------------------------------------------------
// Constants
// ------------------------------------------------------------------------------
const DEFAULTS = [];
// ------------------------------------------------------------------------------
// Rule Definition
// ------------------------------------------------------------------------------
module.exports = {
meta: {
docs: {
description: 'Forbid certain props on DOM Nodes',
category: 'Best Practices',
recommended: false,
url: docsUrl('forbid-dom-props')
},
schema: [{
type: 'object',
properties: {
forbid: {
type: 'array',
items: {
type: 'string',
minLength: 1
},
uniqueItems: true
}
},
additionalProperties: false
}]
},
create(context) {
function isForbidden(prop) {
const configuration = context.options[0] || {};
const forbid = configuration.forbid || DEFAULTS;
return forbid.indexOf(prop) >= 0;
}
return {
JSXAttribute(node) {
const tag = node.parent.name.name;
if (!(tag && tag[0] !== tag[0].toUpperCase())) {
// This is a Component, not a DOM node, so exit.
return;
}
const prop = node.name.name;
if (!isForbidden(prop)) {
return;
}
context.report({
node,
message: `Prop \`${prop}\` is forbidden on DOM Nodes`
});
}
};
}
};