no-noninteractive-element-to-interactive-role.js 3.2 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798
  1. "use strict";
  2. var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
  3. Object.defineProperty(exports, "__esModule", {
  4. value: true
  5. });
  6. exports["default"] = void 0;
  7. var _toConsumableArray2 = _interopRequireDefault(require("@babel/runtime/helpers/toConsumableArray"));
  8. var _ariaQuery = require("aria-query");
  9. var _jsxAstUtils = require("jsx-ast-utils");
  10. var _arrayIncludes = _interopRequireDefault(require("array-includes"));
  11. var _has = _interopRequireDefault(require("has"));
  12. var _getElementType = _interopRequireDefault(require("../util/getElementType"));
  13. var _getExplicitRole = _interopRequireDefault(require("../util/getExplicitRole"));
  14. var _isNonInteractiveElement = _interopRequireDefault(require("../util/isNonInteractiveElement"));
  15. var _isInteractiveRole = _interopRequireDefault(require("../util/isInteractiveRole"));
  16. /**
  17. * @fileoverview Disallow inherently non-interactive elements to be assigned
  18. * interactive roles.
  19. * @author Jesse Beach
  20. *
  21. */
  22. // ----------------------------------------------------------------------------
  23. // Rule Definition
  24. // ----------------------------------------------------------------------------
  25. var errorMessage = 'Non-interactive elements should not be assigned interactive roles.';
  26. var domElements = (0, _toConsumableArray2["default"])(_ariaQuery.dom.keys());
  27. var _default = {
  28. meta: {
  29. docs: {
  30. url: 'https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/tree/HEAD/docs/rules/no-noninteractive-element-to-interactive-role.md',
  31. description: 'Non-interactive elements should not be assigned interactive roles.',
  32. errorOptions: true
  33. },
  34. schema: [{
  35. type: 'object',
  36. additionalProperties: {
  37. type: 'array',
  38. items: {
  39. type: 'string'
  40. },
  41. uniqueItems: true
  42. }
  43. }]
  44. },
  45. create: function create(context) {
  46. var options = context.options;
  47. var elementType = (0, _getElementType["default"])(context);
  48. return {
  49. JSXAttribute: function JSXAttribute(attribute) {
  50. var attributeName = (0, _jsxAstUtils.propName)(attribute); // $FlowFixMe: [TODO] Mark propName as a JSXIdentifier, not a string.
  51. if (attributeName !== 'role') {
  52. return;
  53. }
  54. var node = attribute.parent;
  55. var attributes = node.attributes;
  56. var type = elementType(node);
  57. var role = (0, _getExplicitRole["default"])(type, node.attributes);
  58. if (!(0, _arrayIncludes["default"])(domElements, type)) {
  59. // Do not test higher level JSX components, as we do not know what
  60. // low-level DOM element this maps to.
  61. return;
  62. } // Allow overrides from rule configuration for specific elements and
  63. // roles.
  64. var allowedRoles = options[0] || {};
  65. if ((0, _has["default"])(allowedRoles, type) && (0, _arrayIncludes["default"])(allowedRoles[type], role)) {
  66. return;
  67. }
  68. if ((0, _isNonInteractiveElement["default"])(type, attributes) && (0, _isInteractiveRole["default"])(type, attributes)) {
  69. context.report({
  70. node: attribute,
  71. message: errorMessage
  72. });
  73. }
  74. }
  75. };
  76. }
  77. };
  78. exports["default"] = _default;
  79. module.exports = exports.default;