/
no-restricted-imports.ts
195 lines (182 loc) · 4.99 KB
/
no-restricted-imports.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
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
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
import { TSESTree } from '@typescript-eslint/experimental-utils';
import type {
ArrayOfStringOrObject,
ArrayOfStringOrObjectPatterns,
} from 'eslint/lib/rules/no-restricted-imports';
import ignore, { Ignore } from 'ignore';
import {
createRule,
deepMerge,
InferMessageIdsTypeFromRule,
InferOptionsTypeFromRule,
} from '../util';
import { getESLintCoreRule } from '../util/getESLintCoreRule';
const baseRule = getESLintCoreRule('no-restricted-imports');
export type Options = InferOptionsTypeFromRule<typeof baseRule>;
export type MessageIds = InferMessageIdsTypeFromRule<typeof baseRule>;
const allowTypeImportsOptionSchema = {
allowTypeImports: {
type: 'boolean',
default: false,
},
};
const schemaForMergeArrayOfStringsOrObjects = {
items: {
anyOf: [
{},
{
properties: allowTypeImportsOptionSchema,
},
],
},
};
const schemaForMergeArrayOfStringsOrObjectPatterns = {
anyOf: [
{},
{
items: {
properties: allowTypeImportsOptionSchema,
},
},
],
};
const schema = deepMerge(
{ ...baseRule.meta.schema },
{
anyOf: [
schemaForMergeArrayOfStringsOrObjects,
{
items: {
properties: {
paths: schemaForMergeArrayOfStringsOrObjects,
patterns: schemaForMergeArrayOfStringsOrObjectPatterns,
},
},
},
],
},
);
function isObjectOfPaths(
obj: unknown,
): obj is { paths: ArrayOfStringOrObject } {
return Object.prototype.hasOwnProperty.call(obj, 'paths');
}
function isObjectOfPatterns(
obj: unknown,
): obj is { patterns: ArrayOfStringOrObjectPatterns } {
return Object.prototype.hasOwnProperty.call(obj, 'patterns');
}
function isOptionsArrayOfStringOrObject(
options: Options,
): options is ArrayOfStringOrObject {
if (isObjectOfPaths(options[0])) {
return false;
}
if (isObjectOfPatterns(options[0])) {
return false;
}
return true;
}
function getRestrictedPaths(options: Options): ArrayOfStringOrObject {
if (isOptionsArrayOfStringOrObject(options)) {
return options;
}
if (isObjectOfPaths(options[0])) {
return options[0].paths;
}
return [];
}
function getRestrictedPatterns(
options: Options,
): ArrayOfStringOrObjectPatterns {
if (isObjectOfPatterns(options[0])) {
return options[0].patterns;
}
return [];
}
export default createRule<Options, MessageIds>({
name: 'no-restricted-imports',
meta: {
type: 'suggestion',
docs: {
description: 'Disallow specified modules when loaded by `import`',
recommended: false,
extendsBaseRule: true,
},
messages: baseRule.meta.messages,
fixable: baseRule.meta.fixable,
schema,
},
defaultOptions: [],
create(context) {
const rules = baseRule.create(context);
const { options } = context;
if (options.length === 0) {
return {};
}
const restrictedPaths = getRestrictedPaths(options);
const allowedTypeImportPathNameSet: Set<string> = new Set();
for (const restrictedPath of restrictedPaths) {
if (
typeof restrictedPath === 'object' &&
restrictedPath.allowTypeImports
) {
allowedTypeImportPathNameSet.add(restrictedPath.name);
}
}
function isAllowedTypeImportPath(importSource: string): boolean {
return allowedTypeImportPathNameSet.has(importSource);
}
const restrictedPatterns = getRestrictedPatterns(options);
const allowedImportTypeMatchers: Ignore[] = [];
for (const restrictedPattern of restrictedPatterns) {
if (
typeof restrictedPattern === 'object' &&
restrictedPattern.allowTypeImports
) {
allowedImportTypeMatchers.push(ignore().add(restrictedPattern.group));
}
}
function isAllowedTypeImportPattern(importSource: string): boolean {
return (
allowedImportTypeMatchers.length > 0 &&
allowedImportTypeMatchers.every(matcher => {
return matcher.ignores(importSource);
})
);
}
return {
ImportDeclaration(node): void {
if (node.importKind === 'type') {
const importSource = node.source.value.trim();
if (
!isAllowedTypeImportPath(importSource) &&
!isAllowedTypeImportPattern(importSource)
) {
return rules.ImportDeclaration(node);
}
} else {
return rules.ImportDeclaration(node);
}
},
'ExportNamedDeclaration[source]'(
node: TSESTree.ExportNamedDeclaration & {
source: NonNullable<TSESTree.ExportNamedDeclaration['source']>;
},
): void {
if (node.exportKind === 'type') {
const importSource = node.source.value.trim();
if (
!isAllowedTypeImportPath(importSource) &&
!isAllowedTypeImportPattern(importSource)
) {
return rules.ExportNamedDeclaration(node);
}
} else {
return rules.ExportNamedDeclaration(node);
}
},
ExportAllDeclaration: rules.ExportAllDeclaration,
};
},
});