forked from import-js/eslint-plugin-import
/
export.js
176 lines (146 loc) · 4.77 KB
/
export.js
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
import ExportMap, { recursivePatternCapture } from '../ExportMap';
import docsUrl from '../docsUrl';
import includes from 'array-includes';
/*
Notes on TypeScript namespaces aka TSModuleDeclaration:
There are two forms:
- active namespaces: namespace Foo {} / module Foo {}
- ambient modules; declare module "eslint-plugin-import" {}
active namespaces:
- cannot contain a default export
- cannot contain an export all
- cannot contain a multi name export (export { a, b })
- can have active namespaces nested within them
ambient namespaces:
- can only be defined in .d.ts files
- cannot be nested within active namespaces
- have no other restrictions
*/
const rootProgram = 'root';
const tsTypePrefix = 'type:';
/**
* Detect function overloads like:
* ```ts
* export function foo(a: number);
* export function foo(a: string);
* export function foo(a: number|string) { return a; }
* ```
* @param {Set<Object>} nodes
* @returns {boolean}
*/
function isTypescriptFunctionOverloads(nodes) {
const types = new Set(Array.from(nodes, node => node.parent.type));
return (
types.has('TSDeclareFunction') &&
(
types.size === 1 ||
(types.size === 2 && types.has('FunctionDeclaration'))
)
);
}
module.exports = {
meta: {
type: 'problem',
docs: {
url: docsUrl('export'),
},
schema: [],
},
create(context) {
const namespace = new Map([[rootProgram, new Map()]]);
function addNamed(name, node, parent, isType) {
if (!namespace.has(parent)) {
namespace.set(parent, new Map());
}
const named = namespace.get(parent);
const key = isType ? `${tsTypePrefix}${name}` : name;
let nodes = named.get(key);
if (nodes == null) {
nodes = new Set();
named.set(key, nodes);
}
nodes.add(node);
}
function getParent(node) {
if (node.parent && node.parent.type === 'TSModuleBlock') {
return node.parent.parent;
}
// just in case somehow a non-ts namespace export declaration isn't directly
// parented to the root Program node
return rootProgram;
}
return {
'ExportDefaultDeclaration': (node) => addNamed('default', node, getParent(node)),
'ExportSpecifier': (node) => addNamed(
node.exported.name || node.exported.value,
node.exported,
getParent(node.parent),
),
'ExportNamedDeclaration': function (node) {
if (node.declaration == null) return;
const parent = getParent(node);
// support for old TypeScript versions
const isTypeVariableDecl = node.declaration.kind === 'type';
if (node.declaration.id != null) {
if (includes([
'TSTypeAliasDeclaration',
'TSInterfaceDeclaration',
], node.declaration.type)) {
addNamed(node.declaration.id.name, node.declaration.id, parent, true);
} else {
addNamed(node.declaration.id.name, node.declaration.id, parent, isTypeVariableDecl);
}
}
if (node.declaration.declarations != null) {
for (const declaration of node.declaration.declarations) {
recursivePatternCapture(declaration.id, v =>
addNamed(v.name, v, parent, isTypeVariableDecl));
}
}
},
'ExportAllDeclaration': function (node) {
if (node.source == null) return; // not sure if this is ever true
// `export * as X from 'path'` does not conflict
if (node.exported && node.exported.name) return;
const remoteExports = ExportMap.get(node.source.value, context);
if (remoteExports == null) return;
if (remoteExports.errors.length) {
remoteExports.reportErrors(context, node);
return;
}
const parent = getParent(node);
let any = false;
remoteExports.forEach((v, name) => {
if (name !== 'default') {
any = true; // poor man's filter
addNamed(name, node, parent);
}
});
if (!any) {
context.report(
node.source,
`No named exports found in module '${node.source.value}'.`,
);
}
},
'Program:exit': function () {
for (const [, named] of namespace) {
for (const [name, nodes] of named) {
if (nodes.size <= 1) continue;
if (isTypescriptFunctionOverloads(nodes)) continue;
for (const node of nodes) {
if (name === 'default') {
context.report(node, 'Multiple default exports.');
} else {
context.report(
node,
`Multiple exports of name '${name.replace(tsTypePrefix, '')}'.`,
);
}
}
}
}
},
};
},
};