newlinePerChainedCallRule.js 3.6KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576
  1. "use strict";
  2. /**
  3. * @license
  4. * Copyright 2017 Palantir Technologies, Inc.
  5. *
  6. * Licensed under the Apache License, Version 2.0 (the "License");
  7. * you may not use this file except in compliance with the License.
  8. * You may obtain a copy of the License at
  9. *
  10. * http://www.apache.org/licenses/LICENSE-2.0
  11. *
  12. * Unless required by applicable law or agreed to in writing, software
  13. * distributed under the License is distributed on an "AS IS" BASIS,
  14. * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15. * See the License for the specific language governing permissions and
  16. * limitations under the License.
  17. */
  18. Object.defineProperty(exports, "__esModule", { value: true });
  19. var tslib_1 = require("tslib");
  20. var tsutils_1 = require("tsutils");
  21. var ts = require("typescript");
  22. var Lint = require("..");
  23. var Rule = /** @class */ (function (_super) {
  24. tslib_1.__extends(Rule, _super);
  25. function Rule() {
  26. return _super !== null && _super.apply(this, arguments) || this;
  27. }
  28. Rule.prototype.apply = function (sourceFile) {
  29. return this.applyWithWalker(new NewlinePerChainedCallWalker(sourceFile, this.ruleName, undefined));
  30. };
  31. /* tslint:disable:object-literal-sort-keys */
  32. Rule.metadata = {
  33. ruleName: "newline-per-chained-call",
  34. description: Lint.Utils.dedent(templateObject_1 || (templateObject_1 = tslib_1.__makeTemplateObject(["\n Requires that chained method calls be broken apart onto separate lines."], ["\n Requires that chained method calls be broken apart onto separate lines."]))),
  35. rationale: Lint.Utils.dedent(templateObject_2 || (templateObject_2 = tslib_1.__makeTemplateObject(["\n This style helps to keep code 'vertical', avoiding the need for side-scrolling in IDEs or text editors."], ["\n This style helps to keep code 'vertical', avoiding the need for side-scrolling in IDEs or text editors."]))),
  36. optionsDescription: "Not configurable",
  37. options: null,
  38. type: "style",
  39. typescriptOnly: false,
  40. };
  41. /* tslint:enable:object-literal-sort-keys */
  42. Rule.FAILURE_STRING = "When chaining calls, put method calls on new lines.";
  43. return Rule;
  44. }(Lint.Rules.AbstractRule));
  45. exports.Rule = Rule;
  46. var NewlinePerChainedCallWalker = /** @class */ (function (_super) {
  47. tslib_1.__extends(NewlinePerChainedCallWalker, _super);
  48. function NewlinePerChainedCallWalker() {
  49. return _super !== null && _super.apply(this, arguments) || this;
  50. }
  51. NewlinePerChainedCallWalker.prototype.walk = function (sourceFile) {
  52. var _this = this;
  53. var checkForSameLine = function (node) {
  54. if (tsutils_1.isCallExpression(node) &&
  55. tsutils_1.isPropertyAccessExpression(node.expression) &&
  56. tsutils_1.isSameLine(sourceFile, node.expression.expression.end, node.expression.name.pos) &&
  57. hasChildCall(node.expression)) {
  58. _this.addFailure(node.expression.name.pos - 1, node.expression.name.end, Rule.FAILURE_STRING);
  59. }
  60. return ts.forEachChild(node, checkForSameLine);
  61. };
  62. return ts.forEachChild(sourceFile, checkForSameLine);
  63. };
  64. return NewlinePerChainedCallWalker;
  65. }(Lint.AbstractWalker));
  66. function hasChildCall(node) {
  67. var expression = node.expression;
  68. while (tsutils_1.isPropertyAccessExpression(expression) ||
  69. tsutils_1.isElementAccessExpression(expression)) {
  70. (_a = expression, expression = _a.expression);
  71. }
  72. return expression.kind === ts.SyntaxKind.CallExpression;
  73. var _a;
  74. }
  75. var templateObject_1, templateObject_2;