useLifecycleInterfaceRule.js 3.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172
  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 rules_1 = require("tslint/lib/rules");
  18. var typescript_1 = require("typescript");
  19. var classDeclarationUtils_1 = require("./util/classDeclarationUtils");
  20. var utils_1 = require("./util/utils");
  21. var STYLE_GUIDE_LINK = 'https://angular.io/styleguide#style-09-01';
  22. exports.getFailureMessage = function (failureParameters) {
  23. return sprintf_js_1.sprintf(Rule.FAILURE_STRING, failureParameters.interfaceName, failureParameters.methodName);
  24. };
  25. var Rule = (function (_super) {
  26. __extends(Rule, _super);
  27. function Rule() {
  28. return _super !== null && _super.apply(this, arguments) || this;
  29. }
  30. Rule.prototype.apply = function (sourceFile) {
  31. return this.applyWithFunction(sourceFile, walk);
  32. };
  33. Rule.metadata = {
  34. description: 'Ensures classes implement lifecycle interfaces corresponding to the declared lifecycle methods.',
  35. descriptionDetails: "See more at " + STYLE_GUIDE_LINK,
  36. options: null,
  37. optionsDescription: 'Not configurable.',
  38. rationale: 'Interfaces prescribe typed method signatures. Use those signatures to flag spelling and syntax mistakes.',
  39. ruleName: 'use-lifecycle-interface',
  40. type: 'functionality',
  41. typescriptOnly: true
  42. };
  43. Rule.FAILURE_STRING = "Lifecycle interface %s should be implemented for method %s. (" + STYLE_GUIDE_LINK + ")";
  44. return Rule;
  45. }(rules_1.AbstractRule));
  46. exports.Rule = Rule;
  47. var validateClassDeclaration = function (context, node) {
  48. var declaredLifecycleInterfaces = utils_1.getDeclaredAngularLifecycleInterfaces(node);
  49. var declaredMethods = classDeclarationUtils_1.getDeclaredMethods(node);
  50. for (var _i = 0, declaredMethods_1 = declaredMethods; _i < declaredMethods_1.length; _i++) {
  51. var method = declaredMethods_1[_i];
  52. var methodProperty = method.name;
  53. var methodName = methodProperty.getText();
  54. if (!utils_1.isAngularLifecycleMethod(methodName))
  55. continue;
  56. var interfaceName = utils_1.getLifecycleInterfaceByMethodName(methodName);
  57. var isMethodImplemented = declaredLifecycleInterfaces.includes(utils_1.AngularLifecycleInterfaces[interfaceName]);
  58. if (isMethodImplemented)
  59. continue;
  60. var failure = exports.getFailureMessage({ interfaceName: interfaceName, methodName: methodName });
  61. context.addFailureAtNode(methodProperty, failure);
  62. }
  63. };
  64. var walk = function (context) {
  65. var sourceFile = context.sourceFile;
  66. var callback = function (node) {
  67. if (typescript_1.isClassDeclaration(node))
  68. validateClassDeclaration(context, node);
  69. typescript_1.forEachChild(node, callback);
  70. };
  71. typescript_1.forEachChild(sourceFile, callback);
  72. };