@atlaskit/eslint-plugin-design-system
Version:
The essential plugin for use with the Atlassian Design System.
91 lines • 4.46 kB
JavaScript
import { isNodeOfType } from 'eslint-codemod-utils';
import { createLintRule } from '../utils/create-lint-rule';
var elementsAccessibleNameProps = ['label', 'titleId'];
var POPUP_PACKAGE = '@atlaskit/popup';
var POPUP_IMPORT_SOURCE = '@atlaskit/popup/popup';
var ENTRY_POINT_POPUP_PACKAGE = '@atlassian/entry-points/popup-trigger';
var rule = createLintRule({
meta: {
name: 'use-popup-label',
type: 'suggestion',
docs: {
description: 'Encourages to provide accessible name for Atlassian Design System Popup component.',
recommended: true,
severity: 'warn'
},
messages: {
missingLabelProp: 'Give Popup an accessible name: set titleId to the id of its visible heading, or set label to a concise description of the popup contents when no heading exists.',
labelPropShouldHaveContents: 'Replace the empty Popup label with text describing the popup contents; if a visible heading already provides that name, use titleId to reference its id instead.',
titleIdShouldHaveValue: 'Set Popup.titleId to the non-empty id of a rendered element containing its accessible name; ensure that element exists while the popup contents is displayed.',
noBothPropsUsage: 'Keep one naming prop on Popup: titleId when referencing a visible heading, otherwise label. Remove the other prop without deleting the intended accessible name.'
},
hasSuggestions: true
},
create: function create(context) {
var contextLocalIdentifier = [];
return {
ImportDeclaration: function ImportDeclaration(node) {
if (node.source.value === POPUP_PACKAGE || node.source.value === POPUP_IMPORT_SOURCE || node.source.value === ENTRY_POINT_POPUP_PACKAGE) {
if (node.specifiers.length) {
node.specifiers.forEach(function (spec) {
if (spec.type === 'ImportDefaultSpecifier' && node.source.value !== ENTRY_POINT_POPUP_PACKAGE) {
contextLocalIdentifier.push(spec.local.name);
}
if (spec.type === 'ImportSpecifier' && 'name' in spec.imported) {
if (node.source.value === POPUP_IMPORT_SOURCE && spec.imported.name === 'Popup') {
contextLocalIdentifier.push(spec.local.name);
}
if (node.source.value === ENTRY_POINT_POPUP_PACKAGE && spec.imported.name === 'PopupTrigger') {
contextLocalIdentifier.push(spec.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 componentRoleDialogProp = node.openingElement.attributes.find(function (attr) {
return isNodeOfType(attr, 'JSXAttribute') && isNodeOfType(attr.name, 'JSXIdentifier') && attr.value && isNodeOfType(attr.value, 'Literal') && attr.name.name === 'role' && attr.value.value === 'dialog';
});
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 {
if (componentRoleDialogProp) {
context.report({
node: node.openingElement,
messageId: 'missingLabelProp'
});
} else {
return;
}
}
}
}
};
}
});
export default rule;