labelPositionRule.js 3.1KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970
  1. "use strict";
  2. /**
  3. * @license
  4. * Copyright 2013 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("../index");
  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.applyWithFunction(sourceFile, walk);
  30. };
  31. /* tslint:disable:object-literal-sort-keys */
  32. Rule.metadata = {
  33. ruleName: "label-position",
  34. description: "Only allows labels in sensible locations.",
  35. descriptionDetails: "This rule only allows labels to be on `do/for/while/switch` statements.",
  36. rationale: Lint.Utils.dedent(templateObject_1 || (templateObject_1 = tslib_1.__makeTemplateObject(["\n Labels in JavaScript only can be used in conjunction with `break` or `continue`,\n constructs meant to be used for loop flow control. While you can theoretically use\n labels on any block statement in JS, it is considered poor code structure to do so."], ["\n Labels in JavaScript only can be used in conjunction with \\`break\\` or \\`continue\\`,\n constructs meant to be used for loop flow control. While you can theoretically use\n labels on any block statement in JS, it is considered poor code structure to do so."]))),
  37. optionsDescription: "Not configurable.",
  38. options: null,
  39. optionExamples: [true],
  40. type: "functionality",
  41. typescriptOnly: false,
  42. };
  43. /* tslint:enable:object-literal-sort-keys */
  44. Rule.FAILURE_STRING = "unexpected label on statement";
  45. return Rule;
  46. }(Lint.Rules.AbstractRule));
  47. exports.Rule = Rule;
  48. function walk(ctx) {
  49. return ts.forEachChild(ctx.sourceFile, function cb(node) {
  50. if (tsutils_1.isLabeledStatement(node) && !isLabelable(node.statement)) {
  51. ctx.addFailureAtNode(node.label, Rule.FAILURE_STRING);
  52. }
  53. return ts.forEachChild(node, cb);
  54. });
  55. }
  56. function isLabelable(node) {
  57. switch (node.kind) {
  58. case ts.SyntaxKind.DoStatement:
  59. case ts.SyntaxKind.ForStatement:
  60. case ts.SyntaxKind.ForInStatement:
  61. case ts.SyntaxKind.ForOfStatement:
  62. case ts.SyntaxKind.WhileStatement:
  63. case ts.SyntaxKind.SwitchStatement:
  64. return true;
  65. default:
  66. return false;
  67. }
  68. }
  69. var templateObject_1;