no-redundant-roles.js 3.1 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586
  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 _arrayIncludes = _interopRequireDefault(require("array-includes"));
  8. var _hasown = _interopRequireDefault(require("hasown"));
  9. var _getElementType = _interopRequireDefault(require("../util/getElementType"));
  10. var _getExplicitRole = _interopRequireDefault(require("../util/getExplicitRole"));
  11. var _getImplicitRole = _interopRequireDefault(require("../util/getImplicitRole"));
  12. /**
  13. * @fileoverview Enforce explicit role property is not the
  14. * same as implicit/default role property on element.
  15. * @author Ethan Cohen <@evcohen>
  16. *
  17. */
  18. // ----------------------------------------------------------------------------
  19. // Rule Definition
  20. // ----------------------------------------------------------------------------
  21. var errorMessage = function errorMessage(element, implicitRole) {
  22. return "The element ".concat(element, " has an implicit role of ").concat(implicitRole, ". Defining this explicitly is redundant and should be avoided.");
  23. };
  24. var DEFAULT_ROLE_EXCEPTIONS = {
  25. nav: ['navigation']
  26. };
  27. var _default = exports["default"] = {
  28. meta: {
  29. docs: {
  30. url: 'https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/tree/HEAD/docs/rules/no-redundant-roles.md',
  31. description: 'Enforce explicit role property is not the same as implicit/default role property on element.'
  32. },
  33. schema: [{
  34. type: 'object',
  35. additionalProperties: {
  36. type: 'array',
  37. items: {
  38. type: 'string'
  39. },
  40. uniqueItems: true
  41. }
  42. }]
  43. },
  44. create: function create(context) {
  45. var options = context.options;
  46. var elementType = (0, _getElementType["default"])(context);
  47. return {
  48. JSXOpeningElement: function (_JSXOpeningElement) {
  49. function JSXOpeningElement(_x) {
  50. return _JSXOpeningElement.apply(this, arguments);
  51. }
  52. JSXOpeningElement.toString = function () {
  53. return _JSXOpeningElement.toString();
  54. };
  55. return JSXOpeningElement;
  56. }(function (node) {
  57. var type = elementType(node);
  58. var implicitRole = (0, _getImplicitRole["default"])(type, node.attributes);
  59. var explicitRole = (0, _getExplicitRole["default"])(type, node.attributes);
  60. if (!implicitRole || !explicitRole) {
  61. return;
  62. }
  63. if (implicitRole === explicitRole) {
  64. var allowedRedundantRoles = options[0] || {};
  65. var redundantRolesForElement;
  66. if ((0, _hasown["default"])(allowedRedundantRoles, type)) {
  67. redundantRolesForElement = allowedRedundantRoles[type];
  68. } else {
  69. redundantRolesForElement = DEFAULT_ROLE_EXCEPTIONS[type] || [];
  70. }
  71. if ((0, _arrayIncludes["default"])(redundantRolesForElement, implicitRole)) {
  72. return;
  73. }
  74. context.report({
  75. node,
  76. message: errorMessage(type, implicitRole.toLowerCase())
  77. });
  78. }
  79. })
  80. };
  81. }
  82. };
  83. module.exports = exports.default;