@atlaskit/eslint-plugin-design-system
Version:
The essential plugin for use with the Atlassian Design System.
78 lines • 3.67 kB
JavaScript
import { isNodeOfType } from 'eslint-codemod-utils';
import { createLintRule } from '../utils/create-lint-rule';
var elementsAccessibleNameProps = ['label', 'titleId'];
var rule = createLintRule({
meta: {
name: 'use-button-group-label',
type: 'suggestion',
docs: {
description: 'Ensures button groups are described to assistive technology by a direct label or by another element.',
recommended: true,
severity: 'warn'
},
messages: {
missingLabelProp: 'Missing accessible name. If there is no visible content to associate use `label` prop, otherwise pass id of element to `titleId` prop to be associated as label.',
labelPropShouldHaveContents: 'Define string that labels the interactive element.',
titleIdShouldHaveValue: '`titleId` should reference the id of element that define accessible name.',
noBothPropsUsage: 'Do not include both `titleId` and `label` properties. Use `titleId` if the label text is available in the DOM to reference it, otherwise use `label` to provide accessible name explicitly.'
},
hasSuggestions: true
},
create: function create(context) {
var contextLocalIdentifier = [];
return {
ImportDeclaration: function ImportDeclaration(node) {
var _node$specifiers;
var buttonGroupIdentifier = (_node$specifiers = node.specifiers) === null || _node$specifiers === void 0 ? void 0 : _node$specifiers.filter(function (spec) {
if (node.source.value === '@atlaskit/button') {
var _spec$imported;
return spec.type === 'ImportSpecifier' && 'name' in spec.imported && ((_spec$imported = spec.imported) === null || _spec$imported === void 0 ? void 0 : _spec$imported.name) === 'ButtonGroup';
}
if (node.source.value === '@atlaskit/button/button-group') {
return spec.type === 'ImportDefaultSpecifier';
}
});
if (buttonGroupIdentifier !== null && buttonGroupIdentifier !== void 0 && buttonGroupIdentifier.length) {
var local = buttonGroupIdentifier[0].local;
contextLocalIdentifier.push(local.name);
}
},
JSXElement: function JSXElement(node) {
if (!isNodeOfType(node, 'JSXElement')) {
return;
}
if (!isNodeOfType(node.openingElement.name, 'JSXIdentifier')) {
return;
}
var name = node.openingElement.name.name;
if (contextLocalIdentifier.includes(name)) {
var componentLabelProps = node.openingElement.attributes.filter(function (attr) {
return isNodeOfType(attr, 'JSXAttribute') && isNodeOfType(attr.name, 'JSXIdentifier') && elementsAccessibleNameProps.includes(attr.name.name);
});
if (componentLabelProps.length === 1) {
var prop = componentLabelProps[0];
if ('value' in prop && prop.value) {
if (isNodeOfType(prop.value, 'Literal') && !prop.value.value || isNodeOfType(prop.value, 'JSXExpressionContainer') && !prop.value.expression) {
context.report({
node: prop,
messageId: prop.name.name === 'label' ? 'labelPropShouldHaveContents' : 'titleIdShouldHaveValue'
});
}
}
} else if (componentLabelProps.length > 1) {
context.report({
node: node.openingElement,
messageId: 'noBothPropsUsage'
});
} else {
context.report({
node: node.openingElement,
messageId: 'missingLabelProp'
});
}
}
}
};
}
});
export default rule;