templateAccessibilityElementsContentRule.js 3.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869
  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 angular_1 = require("./angular");
  19. var ngWalker_1 = require("./angular/ngWalker");
  20. var TemplateVisitorCtrl = (function (_super) {
  21. __extends(TemplateVisitorCtrl, _super);
  22. function TemplateVisitorCtrl() {
  23. return _super !== null && _super.apply(this, arguments) || this;
  24. }
  25. TemplateVisitorCtrl.prototype.visitElement = function (ast, context) {
  26. this.validateElement(ast);
  27. _super.prototype.visitElement.call(this, ast, context);
  28. };
  29. TemplateVisitorCtrl.prototype.validateElement = function (element) {
  30. if (Rule.ELEMENTS.indexOf(element.name) === -1) {
  31. return;
  32. }
  33. var hasContent = element.children.length;
  34. var hasInnerContent = element.inputs.some(function (input) { return input.name === 'innerHTML' || input.name === 'innerText'; });
  35. if (hasContent || hasInnerContent) {
  36. return;
  37. }
  38. var _a = element.sourceSpan, endOffset = _a.end.offset, startOffset = _a.start.offset;
  39. this.addFailureFromStartToEnd(startOffset, endOffset, exports.getErrorMessage(element.name));
  40. };
  41. return TemplateVisitorCtrl;
  42. }(angular_1.BasicTemplateAstVisitor));
  43. exports.getErrorMessage = function (element) {
  44. return sprintf_js_1.sprintf(Rule.FAILURE_STRING, element);
  45. };
  46. var Rule = (function (_super) {
  47. __extends(Rule, _super);
  48. function Rule() {
  49. return _super !== null && _super.apply(this, arguments) || this;
  50. }
  51. Rule.prototype.apply = function (sourceFile) {
  52. var walkerConfig = { templateVisitorCtrl: TemplateVisitorCtrl };
  53. var walker = new ngWalker_1.NgWalker(sourceFile, this.getOptions(), walkerConfig);
  54. return this.applyWithWalker(walker);
  55. };
  56. Rule.metadata = {
  57. description: 'Ensures that the heading, anchor and button elements have content in it',
  58. options: null,
  59. optionsDescription: 'Not configurable.',
  60. rationale: 'Heading, anchor and button elements should have content to be accessible by screen readers',
  61. ruleName: 'template-accessibility-elements-content',
  62. type: 'functionality',
  63. typescriptOnly: true
  64. };
  65. Rule.FAILURE_STRING = '<%s/> element should have content';
  66. Rule.ELEMENTS = ['h1', 'h2', 'h3', 'h4', 'h5', 'h6', 'a', 'button'];
  67. return Rule;
  68. }(lib_1.Rules.AbstractRule));
  69. exports.Rule = Rule;