noConflictingLifecycleRule.js 5.0 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192
  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. var __makeTemplateObject = (this && this.__makeTemplateObject) || function (cooked, raw) {
  16. if (Object.defineProperty) { Object.defineProperty(cooked, "raw", { value: raw }); } else { cooked.raw = raw; }
  17. return cooked;
  18. };
  19. Object.defineProperty(exports, "__esModule", { value: true });
  20. var sprintf_js_1 = require("sprintf-js");
  21. var rules_1 = require("tslint/lib/rules");
  22. var utils_1 = require("tslint/lib/utils");
  23. var typescript_1 = require("typescript");
  24. var utils_2 = require("./util/utils");
  25. var LIFECYCLE_INTERFACES = [
  26. utils_2.AngularLifecycleInterfaces.DoCheck,
  27. utils_2.AngularLifecycleInterfaces.OnChanges
  28. ];
  29. var LIFECYCLE_METHODS = [
  30. utils_2.AngularLifecycleMethods.ngDoCheck,
  31. utils_2.AngularLifecycleMethods.ngOnChanges
  32. ];
  33. exports.getFailureMessage = function (failureParameters) { return sprintf_js_1.sprintf(failureParameters.message); };
  34. var Rule = (function (_super) {
  35. __extends(Rule, _super);
  36. function Rule() {
  37. return _super !== null && _super.apply(this, arguments) || this;
  38. }
  39. Rule.prototype.apply = function (sourceFile) {
  40. return this.applyWithFunction(sourceFile, walk);
  41. };
  42. Rule.metadata = {
  43. description: 'Ensures that directives not implement conflicting lifecycle interfaces.',
  44. descriptionDetails: 'See more at https://angular.io/api/core/DoCheck#description.',
  45. options: null,
  46. optionsDescription: 'Not configurable.',
  47. rationale: utils_1.dedent(templateObject_1 || (templateObject_1 = __makeTemplateObject(["\n A directive typically should not use both ", " and ", " to respond\n to changes on the same input, as ", " will continue to be called when the\n default change detector detects changes.\n "], ["\n A directive typically should not use both ", " and ", " to respond\n to changes on the same input, as ", " will continue to be called when the\n default change detector detects changes.\n "])), utils_2.AngularLifecycleInterfaces.DoCheck, utils_2.AngularLifecycleInterfaces.OnChanges, utils_2.AngularLifecycleMethods.ngOnChanges),
  48. ruleName: 'no-conflicting-lifecycle',
  49. type: 'maintainability',
  50. typescriptOnly: true
  51. };
  52. Rule.FAILURE_STRING_INTERFACE_HOOK = utils_1.dedent(templateObject_2 || (templateObject_2 = __makeTemplateObject(["\n Implementing ", " and ", " in a class is not recommended\n "], ["\n Implementing ", " and ", " in a class is not recommended\n "])), utils_2.AngularLifecycleInterfaces.DoCheck, utils_2.AngularLifecycleInterfaces.OnChanges);
  53. Rule.FAILURE_STRING_METHOD_HOOK = utils_1.dedent(templateObject_3 || (templateObject_3 = __makeTemplateObject(["\n Declaring ", " and ", " method in a class is not recommended\n "], ["\n Declaring ", " and ", " method in a class is not recommended\n "])), utils_2.AngularLifecycleMethods.ngDoCheck, utils_2.AngularLifecycleMethods.ngOnChanges);
  54. return Rule;
  55. }(rules_1.AbstractRule));
  56. exports.Rule = Rule;
  57. var validateClassDeclaration = function (context, node) {
  58. validateInterfaces(context, node);
  59. validateMethods(context, node);
  60. };
  61. var validateInterfaces = function (context, node) {
  62. var declaredAngularLifecycleInterfaces = utils_2.getDeclaredAngularLifecycleInterfaces(node);
  63. var hasConflictingLifecycle = LIFECYCLE_INTERFACES.every(function (lifecycleInterface) {
  64. return declaredAngularLifecycleInterfaces.includes(lifecycleInterface);
  65. });
  66. if (!hasConflictingLifecycle)
  67. return;
  68. var failure = exports.getFailureMessage({
  69. message: Rule.FAILURE_STRING_INTERFACE_HOOK
  70. });
  71. context.addFailureAtNode(node, failure);
  72. };
  73. var validateMethods = function (context, node) {
  74. var declaredAngularLifecycleMethods = utils_2.getDeclaredAngularLifecycleMethods(node);
  75. var hasConflictingLifecycle = LIFECYCLE_METHODS.every(function (lifecycleMethod) { return declaredAngularLifecycleMethods.includes(lifecycleMethod); });
  76. if (!hasConflictingLifecycle)
  77. return;
  78. var failure = exports.getFailureMessage({
  79. message: Rule.FAILURE_STRING_METHOD_HOOK
  80. });
  81. context.addFailureAtNode(node, failure);
  82. };
  83. var walk = function (context) {
  84. var sourceFile = context.sourceFile;
  85. var callback = function (node) {
  86. if (typescript_1.isClassDeclaration(node))
  87. validateClassDeclaration(context, node);
  88. typescript_1.forEachChild(node, callback);
  89. };
  90. typescript_1.forEachChild(sourceFile, callback);
  91. };
  92. var templateObject_1, templateObject_2, templateObject_3;