This repository has been archived by the owner on Mar 25, 2021. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 889
/
unnecessaryElseRule.ts
120 lines (106 loc) · 4.19 KB
/
unnecessaryElseRule.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
/**
* @license
* Copyright 2019 Palantir Technologies, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import * as utils from "tsutils";
import * as ts from "typescript";
import * as Lint from "../index";
import { codeExamples } from "./code-examples/unnecessaryElse.examples";
export class Rule extends Lint.Rules.AbstractRule {
/* tslint:disable:object-literal-sort-keys */
public static metadata: Lint.IRuleMetadata = {
description: Lint.Utils.dedent`
Disallows \`else\` blocks following \`if\` blocks ending with a \`break\`, \`continue\`, \`return\`, or \`throw\` statement.`,
descriptionDetails: "",
optionExamples: [true, [true, { allowElseIf: true }]],
options: {
type: "object",
properties: {
allowElseIf: { type: "boolean" },
},
},
optionsDescription: Lint.Utils.dedent`
You can optionally specify the option \`"allowElseIf"\` to allow "else if" statements.
`,
rationale: Lint.Utils.dedent`
When an \`if\` block is guaranteed to exit control flow when entered,
it is unnecessary to add an \`else\` statement.
The contents that would be in the \`else\` block can be placed after the end of the \`if\` block.`,
ruleName: "unnecessary-else",
type: "style",
typescriptOnly: false,
codeExamples,
};
/* tslint:disable:object-literal-sort-keys */
public static FAILURE_STRING(name: string): string {
return `The preceding \`if\` block ends with a \`${name}\` statement. This \`else\` is unnecessary.`;
}
public apply(sourceFile: ts.SourceFile): Lint.RuleFailure[] {
return this.applyWithFunction(sourceFile, walk, parseOptions(this.ruleArguments[0]));
}
}
interface Options {
allowElseIf: boolean;
}
function parseOptions(option: Partial<Options> | undefined): Options {
return {
allowElseIf: false,
...option,
};
}
function walk(ctx: Lint.WalkContext<Options>): void {
ts.forEachChild(ctx.sourceFile, function cb(node: ts.Node): void {
if (utils.isIfStatement(node)) {
const jumpStatement = utils.isBlock(node.thenStatement)
? getJumpStatement(getLastStatement(node.thenStatement))
: getJumpStatement(node.thenStatement);
if (jumpStatement !== undefined && node.elseStatement !== undefined) {
if (!utils.isIfStatement(node.elseStatement) || !ctx.options.allowElseIf) {
const elseKeyword = getPositionOfElseKeyword(node, ts.SyntaxKind.ElseKeyword);
ctx.addFailureAtNode(elseKeyword, Rule.FAILURE_STRING(jumpStatement));
}
}
}
return ts.forEachChild(node, cb);
});
}
function getPositionOfElseKeyword(node: ts.Node, kind: ts.SyntaxKind) {
return node.getChildren().filter(child => child.kind === kind)[0];
}
function getJumpStatement(node: ts.Statement): string | undefined {
switch (node.kind) {
case ts.SyntaxKind.BreakStatement:
return "break";
case ts.SyntaxKind.ContinueStatement:
return "continue";
case ts.SyntaxKind.ThrowStatement:
return "throw";
case ts.SyntaxKind.ReturnStatement:
return "return";
default:
return undefined;
}
}
function getLastStatement(clause: ts.Block): ts.Statement {
const block = clause.statements[0];
const statements =
clause.statements.length === 1 && utils.isBlock(block)
? block.statements
: clause.statements;
return last(statements);
}
function last<T>(arr: ReadonlyArray<T>): T {
return arr[arr.length - 1];
}