forked from palantir/tslint
-
Notifications
You must be signed in to change notification settings - Fork 0
/
noAngleBracketTypeAssertionRule.ts
50 lines (44 loc) · 2 KB
/
noAngleBracketTypeAssertionRule.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
/**
* @license
* Copyright 2016 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 ts from "typescript";
import * as Lint from "../lint";
export class Rule extends Lint.Rules.AbstractRule {
/* tslint:disable:object-literal-sort-keys */
public static metadata: Lint.IRuleMetadata = {
ruleName: "no-angle-bracket-type-assertion",
description: "Requires the use of `as Type` for type assertions instead of `<Type>`.",
rationale: Lint.Utils.dedent`
Both formats of type assertions have the same effect, but only \`as\` type assertions
work in \`.tsx\` files. This rule ensures that you have a consistent type assertion style
across your codebase.`,
optionsDescription: "Not configurable.",
options: null,
optionExamples: ["true"],
type: "style",
};
/* tslint:enable:object-literal-sort-keys */
public static FAILURE_STRING = "Type assertion using the '<>' syntax is forbidden. Use the 'as' syntax instead.";
public apply(sourceFile: ts.SourceFile): Lint.RuleFailure[] {
return this.applyWithWalker(new NoAngleBracketTypeAssertionWalker(sourceFile, this.getOptions()));
}
}
class NoAngleBracketTypeAssertionWalker extends Lint.RuleWalker {
public visitTypeAssertionExpression(node: ts.TypeAssertion) {
this.addFailure(this.createFailure(node.getStart(), node.getWidth(), Rule.FAILURE_STRING));
super.visitTypeAssertionExpression(node);
}
}