eslint-config-chain-able
Version:
an opinionated ESLint configuration
47 lines (37 loc) • 1.27 kB
JavaScript
/**
* @fileoverview Enforce anchor elements to contain accessible content.
* @author Lisa Ring & Niklas Holmberg
*/
// ----------------------------------------------------------------------------
// Rule Definition
// ----------------------------------------------------------------------------
import { elementType } from 'jsx-ast-utils';
import { arraySchema, generateObjSchema } from '../util/schemas';
import hasAccessibleChild from '../util/hasAccessibleChild';
const errorMessage =
'Anchors must have content and the content must be accessible by a screen reader.';
const schema = generateObjSchema({ components: arraySchema });
module.exports = {
meta: {
docs: {},
schema: [schema],
},
create: context => ({
JSXOpeningElement: (node) => {
const options = context.options[0] || {};
const componentOptions = options.components || [];
const typeCheck = ['a'].concat(componentOptions);
const nodeType = elementType(node);
// Only check anchor elements and custom types.
if (typeCheck.indexOf(nodeType) === -1) {
return;
} else if (hasAccessibleChild(node.parent)) {
return;
}
context.report({
node,
message: errorMessage,
});
},
}),
};