no-redundant-roles.js 2.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990
  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 _has = _interopRequireDefault(require("has"));
  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 = {
  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(node) {
  49. var type = elementType(node);
  50. var implicitRole = (0, _getImplicitRole["default"])(type, node.attributes);
  51. var explicitRole = (0, _getExplicitRole["default"])(type, node.attributes);
  52. if (!implicitRole || !explicitRole) {
  53. return;
  54. }
  55. if (implicitRole === explicitRole) {
  56. var allowedRedundantRoles = options[0] || {};
  57. var redundantRolesForElement;
  58. if ((0, _has["default"])(allowedRedundantRoles, type)) {
  59. redundantRolesForElement = allowedRedundantRoles[type];
  60. } else {
  61. redundantRolesForElement = DEFAULT_ROLE_EXCEPTIONS[type] || [];
  62. }
  63. if ((0, _arrayIncludes["default"])(redundantRolesForElement, implicitRole)) {
  64. return;
  65. }
  66. context.report({
  67. node,
  68. message: errorMessage(type, implicitRole.toLowerCase())
  69. });
  70. }
  71. }
  72. };
  73. }
  74. };
  75. exports["default"] = _default;
  76. module.exports = exports.default;