orionsoft-react-scripts
Version:
Orionsoft Configuration and scripts for Create React App.
87 lines (74 loc) • 2.04 kB
JavaScript
/**
* @fileoverview Enforce heading (h1, h2, etc) elements contain accessible content.
* @author Ethan Cohen
*/
// ----------------------------------------------------------------------------
// Rule Definition
// ----------------------------------------------------------------------------
import { elementType, hasAnyProp } from 'jsx-ast-utils';
import isHiddenFromScreenReader from '../util/isHiddenFromScreenReader';
const errorMessage =
'Headings must have content and the content must be accessible by a screen reader.';
const headings = [
'h1',
'h2',
'h3',
'h4',
'h5',
'h6',
];
module.exports = {
meta: {
docs: {},
schema: [
{
oneOf: [
{ type: 'string' },
{
type: 'array',
items: {
type: 'string',
},
minItems: 1,
uniqueItems: true,
},
],
},
],
},
create: context => ({
JSXOpeningElement: (node) => {
const typeCheck = headings.concat(context.options[0]);
const nodeType = elementType(node);
// Only check 'h*' elements and custom types.
if (typeCheck.indexOf(nodeType) === -1) {
return;
}
const isAccessible = node.parent.children.some((child) => {
switch (child.type) {
case 'Literal':
return Boolean(child.value);
case 'JSXElement':
return !isHiddenFromScreenReader(
elementType(child.openingElement),
child.openingElement.attributes
);
case 'JSXExpressionContainer':
if (child.expression.type === 'Identifier') {
return child.expression.name !== 'undefined';
}
return true;
default:
return false;
}
}) || hasAnyProp(node.attributes, ['dangerouslySetInnerHTML', 'children']);
if (isAccessible) {
return;
}
context.report({
node,
message: errorMessage,
});
},
}),
};