4 * Copyright 2013 Palantir Technologies, Inc.
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
10 * http://www.apache.org/licenses/LICENSE-2.0
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.
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);
26 return _super !== null && _super.apply(this, arguments) || this;
28 Rule.prototype.apply = function (sourceFile) {
29 return this.applyWithFunction(sourceFile, walk);
31 /* tslint:disable:object-literal-sort-keys */
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.",
39 optionExamples: [true],
40 type: "functionality",
41 typescriptOnly: false,
43 /* tslint:enable:object-literal-sort-keys */
44 Rule.FAILURE_STRING = "unexpected label on statement";
46 }(Lint.Rules.AbstractRule));
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);
53 return ts.forEachChild(node, cb);
56 function isLabelable(node) {
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: