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
/
noSubmoduleImportsRule.ts
109 lines (99 loc) · 4.14 KB
/
noSubmoduleImportsRule.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
/**
* @license
* Copyright 2017 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 {
isCallExpression,
isExternalModuleReference,
isIdentifier,
isImportDeclaration,
isImportEqualsDeclaration,
isTextualLiteral,
} from "tsutils";
import * as ts from "typescript";
import * as Lint from "../index";
export class Rule extends Lint.Rules.AbstractRule {
/* tslint:disable:object-literal-sort-keys */
public static metadata: Lint.IRuleMetadata = {
ruleName: "no-submodule-imports",
description: Lint.Utils.dedent`
Disallows importing any submodule.`,
rationale: Lint.Utils.dedent`
Submodules of some packages are treated as private APIs and the import
paths may change without deprecation periods. It's best to stick with
top-level package exports.`,
optionsDescription: "A list of whitelisted package or submodule names.",
options: {
type: "array",
items: {
type: "string",
},
},
optionExamples: [true, [true, "rxjs", "@angular/platform-browser", "@angular/core/testing"]],
type: "functionality",
typescriptOnly: false,
};
public static FAILURE_STRING = "Submodule import paths from this package are disallowed; import from the root instead";
public apply(sourceFile: ts.SourceFile): Lint.RuleFailure[] {
return this.applyWithWalker(new NoSubmoduleImportsWalker(sourceFile, this.ruleName, this.ruleArguments));
}
}
class NoSubmoduleImportsWalker extends Lint.AbstractWalker<string[]> {
public walk(sourceFile: ts.SourceFile) {
const findDynamicImport = (node: ts.Node): void => {
if (isCallExpression(node) && node.arguments.length === 1 &&
(isIdentifier(node.expression) && node.expression.text === "require" ||
node.expression.kind === ts.SyntaxKind.ImportKeyword)) {
this.checkForBannedImport(node.arguments[0]);
}
return ts.forEachChild(node, findDynamicImport);
};
for (const statement of sourceFile.statements) {
if (isImportDeclaration(statement)) {
this.checkForBannedImport(statement.moduleSpecifier);
} else if (isImportEqualsDeclaration(statement)) {
if (isExternalModuleReference(statement.moduleReference) && statement.moduleReference.expression !== undefined) {
this.checkForBannedImport(statement.moduleReference.expression);
}
} else {
ts.forEachChild(statement, findDynamicImport);
}
}
}
private checkForBannedImport(expression: ts.Expression) {
if (isTextualLiteral(expression) &&
// TODO remove assertion on upgrade to typescript@2.5.2
!(ts as any as {isExternalModuleNameRelative(m: string): boolean}).isExternalModuleNameRelative(expression.text) &&
isSubmodulePath(expression.text)) {
/*
* A submodule is being imported.
* Check if its path contains any
* of the whitelist packages.
*/
for (const option of this.options) {
if (expression.text === option || expression.text.startsWith(`${option}/`)) {
return;
}
}
this.addFailureAtNode(expression, Rule.FAILURE_STRING);
}
}
}
function isScopedPath(path: string): boolean {
return path[0] === "@";
}
function isSubmodulePath(path: string): boolean {
return path.split("/").length > (isScopedPath(path) ? 2 : 1);
}