no-unnecessary-qualifier.js
6.76 KB
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
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
"use strict";
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
}) : (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
o[k2] = m[k];
}));
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
Object.defineProperty(o, "default", { enumerable: true, value: v });
}) : function(o, v) {
o["default"] = v;
});
var __importStar = (this && this.__importStar) || function (mod) {
if (mod && mod.__esModule) return mod;
var result = {};
if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
__setModuleDefault(result, mod);
return result;
};
Object.defineProperty(exports, "__esModule", { value: true });
const experimental_utils_1 = require("@typescript-eslint/experimental-utils");
const ts = __importStar(require("typescript"));
const tsutils = __importStar(require("tsutils"));
const util = __importStar(require("../util"));
exports.default = util.createRule({
name: 'no-unnecessary-qualifier',
meta: {
docs: {
category: 'Best Practices',
description: 'Warns when a namespace qualifier is unnecessary',
recommended: false,
requiresTypeChecking: true,
},
fixable: 'code',
messages: {
unnecessaryQualifier: "Qualifier is unnecessary since '{{ name }}' is in scope.",
},
schema: [],
type: 'suggestion',
},
defaultOptions: [],
create(context) {
const namespacesInScope = [];
let currentFailedNamespaceExpression = null;
const parserServices = util.getParserServices(context);
const esTreeNodeToTSNodeMap = parserServices.esTreeNodeToTSNodeMap;
const program = parserServices.program;
const checker = program.getTypeChecker();
const sourceCode = context.getSourceCode();
function tryGetAliasedSymbol(symbol, checker) {
return tsutils.isSymbolFlagSet(symbol, ts.SymbolFlags.Alias)
? checker.getAliasedSymbol(symbol)
: null;
}
function symbolIsNamespaceInScope(symbol) {
var _a;
const symbolDeclarations = (_a = symbol.getDeclarations()) !== null && _a !== void 0 ? _a : [];
if (symbolDeclarations.some(decl => namespacesInScope.some(ns => ns === decl))) {
return true;
}
const alias = tryGetAliasedSymbol(symbol, checker);
return alias !== null && symbolIsNamespaceInScope(alias);
}
function getSymbolInScope(node, flags, name) {
// TODO:PERF `getSymbolsInScope` gets a long list. Is there a better way?
const scope = checker.getSymbolsInScope(node, flags);
return scope.find(scopeSymbol => scopeSymbol.name === name);
}
function symbolsAreEqual(accessed, inScope) {
return accessed === checker.getExportSymbolOfSymbol(inScope);
}
function qualifierIsUnnecessary(qualifier, name) {
const tsQualifier = esTreeNodeToTSNodeMap.get(qualifier);
const tsName = esTreeNodeToTSNodeMap.get(name);
const namespaceSymbol = checker.getSymbolAtLocation(tsQualifier);
if (typeof namespaceSymbol === 'undefined' ||
!symbolIsNamespaceInScope(namespaceSymbol)) {
return false;
}
const accessedSymbol = checker.getSymbolAtLocation(tsName);
if (typeof accessedSymbol === 'undefined') {
return false;
}
// If the symbol in scope is different, the qualifier is necessary.
const fromScope = getSymbolInScope(tsQualifier, accessedSymbol.flags, sourceCode.getText(name));
return (typeof fromScope === 'undefined' ||
symbolsAreEqual(accessedSymbol, fromScope));
}
function visitNamespaceAccess(node, qualifier, name) {
// Only look for nested qualifier errors if we didn't already fail on the outer qualifier.
if (!currentFailedNamespaceExpression &&
qualifierIsUnnecessary(qualifier, name)) {
currentFailedNamespaceExpression = node;
context.report({
node: qualifier,
messageId: 'unnecessaryQualifier',
data: {
name: sourceCode.getText(name),
},
fix(fixer) {
return fixer.removeRange([qualifier.range[0], name.range[0]]);
},
});
}
}
function enterDeclaration(node) {
namespacesInScope.push(esTreeNodeToTSNodeMap.get(node));
}
function exitDeclaration() {
namespacesInScope.pop();
}
function resetCurrentNamespaceExpression(node) {
if (node === currentFailedNamespaceExpression) {
currentFailedNamespaceExpression = null;
}
}
function isPropertyAccessExpression(node) {
return node.type === experimental_utils_1.AST_NODE_TYPES.MemberExpression && !node.computed;
}
function isEntityNameExpression(node) {
return (node.type === experimental_utils_1.AST_NODE_TYPES.Identifier ||
(isPropertyAccessExpression(node) &&
isEntityNameExpression(node.object)));
}
return {
TSModuleDeclaration: enterDeclaration,
TSEnumDeclaration: enterDeclaration,
'ExportNamedDeclaration[declaration.type="TSModuleDeclaration"]': enterDeclaration,
'ExportNamedDeclaration[declaration.type="TSEnumDeclaration"]': enterDeclaration,
'TSModuleDeclaration:exit': exitDeclaration,
'TSEnumDeclaration:exit': exitDeclaration,
'ExportNamedDeclaration[declaration.type="TSModuleDeclaration"]:exit': exitDeclaration,
'ExportNamedDeclaration[declaration.type="TSEnumDeclaration"]:exit': exitDeclaration,
TSQualifiedName(node) {
visitNamespaceAccess(node, node.left, node.right);
},
'MemberExpression[computed=false]': function (node) {
const property = node.property;
if (isEntityNameExpression(node.object)) {
visitNamespaceAccess(node, node.object, property);
}
},
'TSQualifiedName:exit': resetCurrentNamespaceExpression,
'MemberExpression:exit': resetCurrentNamespaceExpression,
};
},
});
//# sourceMappingURL=no-unnecessary-qualifier.js.map