4 * Copyright 2018 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: "no-angle-bracket-type-assertion",
34 description: "Requires the use of `as Type` for type assertions instead of `<Type>`.",
36 rationale: Lint.Utils.dedent(templateObject_1 || (templateObject_1 = tslib_1.__makeTemplateObject(["\n Both formats of type assertions have the same effect, but only `as` type assertions\n work in `.tsx` files. This rule ensures that you have a consistent type assertion style\n across your codebase."], ["\n Both formats of type assertions have the same effect, but only \\`as\\` type assertions\n work in \\`.tsx\\` files. This rule ensures that you have a consistent type assertion style\n across your codebase."]))),
37 optionsDescription: "Not configurable.",
39 optionExamples: [true],
43 /* tslint:enable:object-literal-sort-keys */
44 Rule.FAILURE_STRING = "Type assertion using the '<>' syntax is forbidden. Use the 'as' syntax instead.";
46 }(Lint.Rules.AbstractRule));
49 return ts.forEachChild(ctx.sourceFile, function cb(node) {
50 if (tsutils_1.isTypeAssertion(node)) {
51 var expression = node.expression;
52 var start = node.getStart(ctx.sourceFile);
53 var addParens = tsutils_1.isBinaryExpression(node.parent);
54 var replaceText = " as " + node.type.getText(ctx.sourceFile) + (addParens ? ")" : "");
55 while (tsutils_1.isTypeAssertion(expression)) {
56 replaceText = " as " + expression.type.getText(ctx.sourceFile) + replaceText;
57 expression = expression.expression;
59 ctx.addFailure(start, node.end, Rule.FAILURE_STRING, [
60 Lint.Replacement.appendText(node.end, replaceText),
61 Lint.Replacement.replaceFromTo(start, expression.getStart(ctx.sourceFile), addParens ? "(" : ""),
63 return cb(expression);
65 return ts.forEachChild(node, cb);