templateAccessibilityAltTextRule.js 5.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106
  1. "use strict";
  2. var __extends = (this && this.__extends) || (function () {
  3. var extendStatics = function (d, b) {
  4. extendStatics = Object.setPrototypeOf ||
  5. ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
  6. function (d, b) { for (var p in b) if (b.hasOwnProperty(p)) d[p] = b[p]; };
  7. return extendStatics(d, b);
  8. };
  9. return function (d, b) {
  10. extendStatics(d, b);
  11. function __() { this.constructor = d; }
  12. d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
  13. };
  14. })();
  15. Object.defineProperty(exports, "__esModule", { value: true });
  16. var sprintf_js_1 = require("sprintf-js");
  17. var lib_1 = require("tslint/lib");
  18. var ngWalker_1 = require("./angular/ngWalker");
  19. var basicTemplateAstVisitor_1 = require("./angular/templates/basicTemplateAstVisitor");
  20. var Rule = (function (_super) {
  21. __extends(Rule, _super);
  22. function Rule() {
  23. return _super !== null && _super.apply(this, arguments) || this;
  24. }
  25. Rule.prototype.apply = function (sourceFile) {
  26. var walkerConfig = { templateVisitorCtrl: TemplateVisitorCtrl };
  27. var walker = new ngWalker_1.NgWalker(sourceFile, this.getOptions(), walkerConfig);
  28. return this.applyWithWalker(walker);
  29. };
  30. Rule.metadata = {
  31. description: 'Enforces alternate text for elements which require the alt, aria-label, aria-labelledby attributes',
  32. options: null,
  33. optionsDescription: 'Not configurable.',
  34. rationale: 'Alternate text lets screen readers provide more information to end users.',
  35. ruleName: 'template-accessibility-alt-text',
  36. type: 'functionality',
  37. typescriptOnly: true
  38. };
  39. Rule.FAILURE_STRING = '%s element must have a text alternative.';
  40. Rule.DEFAULT_ELEMENTS = ['img', 'object', 'area', 'input[type="image"]'];
  41. return Rule;
  42. }(lib_1.Rules.AbstractRule));
  43. exports.Rule = Rule;
  44. exports.getFailureMessage = function (name) {
  45. return sprintf_js_1.sprintf(Rule.FAILURE_STRING, name);
  46. };
  47. var TemplateVisitorCtrl = (function (_super) {
  48. __extends(TemplateVisitorCtrl, _super);
  49. function TemplateVisitorCtrl() {
  50. return _super !== null && _super.apply(this, arguments) || this;
  51. }
  52. TemplateVisitorCtrl.prototype.visitElement = function (ast, context) {
  53. this.validateElement(ast);
  54. _super.prototype.visitElement.call(this, ast, context);
  55. };
  56. TemplateVisitorCtrl.prototype.validateElement = function (element) {
  57. var typesToValidate = Rule.DEFAULT_ELEMENTS.map(function (type) {
  58. if (type === 'input[type="image"]') {
  59. return 'input';
  60. }
  61. return type;
  62. });
  63. if (typesToValidate.indexOf(element.name) === -1) {
  64. return;
  65. }
  66. var isValid = this[element.name](element);
  67. if (isValid) {
  68. return;
  69. }
  70. var _a = element.sourceSpan, endOffset = _a.end.offset, startOffset = _a.start.offset;
  71. this.addFailureFromStartToEnd(startOffset, endOffset, exports.getFailureMessage(element.name));
  72. };
  73. TemplateVisitorCtrl.prototype.img = function (element) {
  74. var hasAltAttr = element.attrs.some(function (attr) { return attr.name === 'alt'; });
  75. var hasAltInput = element.inputs.some(function (input) { return input.name === 'alt'; });
  76. return hasAltAttr || hasAltInput;
  77. };
  78. TemplateVisitorCtrl.prototype.object = function (element) {
  79. var elementHasText = '';
  80. var hasLabelAttr = element.attrs.some(function (attr) { return attr.name === 'aria-label' || attr.name === 'aria-labelledby'; });
  81. var hasLabelInput = element.inputs.some(function (input) { return input.name === 'aria-label' || input.name === 'aria-labelledby'; });
  82. var hasTitleAttr = element.attrs.some(function (attr) { return attr.name === 'title'; });
  83. var hasTitleInput = element.inputs.some(function (input) { return input.name === 'title'; });
  84. if (element.children.length) {
  85. elementHasText = element.children[0].value;
  86. }
  87. return hasLabelAttr || hasLabelInput || hasTitleAttr || hasTitleInput || elementHasText;
  88. };
  89. TemplateVisitorCtrl.prototype.area = function (element) {
  90. var hasLabelAttr = element.attrs.some(function (attr) { return attr.name === 'aria-label' || attr.name === 'aria-labelledby'; });
  91. var hasLabelInput = element.inputs.some(function (input) { return input.name === 'aria-label' || input.name === 'aria-labelledby'; });
  92. var hasAltAttr = element.attrs.some(function (attr) { return attr.name === 'alt'; });
  93. var hasAltInput = element.inputs.some(function (input) { return input.name === 'alt'; });
  94. return hasAltAttr || hasAltInput || hasLabelAttr || hasLabelInput;
  95. };
  96. TemplateVisitorCtrl.prototype.input = function (element) {
  97. var attrType = element.attrs.find(function (attr) { return attr.name === 'type'; }) || {};
  98. var inputType = element.inputs.find(function (input) { return input.name === 'type'; }) || {};
  99. var type = attrType.value || inputType.value;
  100. if (type !== 'image') {
  101. return true;
  102. }
  103. return this.area(element);
  104. };
  105. return TemplateVisitorCtrl;
  106. }(basicTemplateAstVisitor_1.BasicTemplateAstVisitor));