-
-
Notifications
You must be signed in to change notification settings - Fork 337
/
export.rs
357 lines (342 loc) · 11.9 KB
/
export.rs
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
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
use std::path::PathBuf;
use oxc_diagnostics::{
miette::{self, Diagnostic},
thiserror::{self, Error},
};
use oxc_macros::declare_oxc_lint;
use oxc_semantic::ModuleRecord;
use oxc_span::{CompactStr, Span};
use rustc_hash::{FxHashMap, FxHashSet};
use crate::{context::LintContext, rule::Rule};
#[derive(Debug, Error, Diagnostic)]
enum ExportDiagnostic {
#[error("eslint-plugin-import(export): Multiple exports of name '{1}'.")]
#[diagnostic(severity(warning))]
MultipleNamedExport(#[label] Span, CompactStr),
#[error("eslint-plugin-import(export): No named exports found in module '{1}'")]
#[diagnostic(severity(warning))]
NoNamedExport(#[label] Span, CompactStr),
}
/// <https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/export.md>
#[derive(Debug, Default, Clone)]
pub struct Export;
declare_oxc_lint!(
/// ### What it does
/// Reports funny business with exports, like repeated exports of names or defaults.
///
/// ### Example
/// ```javascript
/// let foo;
/// export { foo }; // Multiple exports of name 'foo'.
/// export * from "./export-all" // export-all.js also export foo
/// ```
Export,
correctness
);
impl Rule for Export {
fn run_once(&self, ctx: &LintContext<'_>) {
let module_record = ctx.semantic().module_record();
let named_export = &module_record.exported_bindings;
let mut duplicated_named_export = FxHashMap::default();
for export_entry in &module_record.star_export_entries {
let Some(module_request) = &export_entry.module_request else {
continue;
};
let Some(remote_module_record_ref) =
module_record.loaded_modules.get(module_request.name())
else {
continue;
};
let remote_module_record = remote_module_record_ref.value();
let mut all_export_names = FxHashSet::default();
let mut visited = FxHashSet::default();
walk_exported_recursive(remote_module_record, &mut all_export_names, &mut visited);
if all_export_names.is_empty() {
ctx.diagnostic(ExportDiagnostic::NoNamedExport(
module_request.span(),
module_request.name().clone(),
));
continue;
}
for name in &all_export_names {
if let Some(span) = named_export.get(name) {
duplicated_named_export.entry(*span).or_insert_with(|| name.clone());
}
}
}
for (span, name) in duplicated_named_export {
ctx.diagnostic(ExportDiagnostic::MultipleNamedExport(span, name));
}
for name_span in &module_record.exported_bindings_duplicated {
let name = name_span.name().clone();
if let Some(span) = module_record.exported_bindings.get(&name) {
ctx.diagnostic(ExportDiagnostic::MultipleNamedExport(*span, name.clone()));
}
ctx.diagnostic(ExportDiagnostic::MultipleNamedExport(name_span.span(), name));
}
if !module_record.export_default_duplicated.is_empty() {
if let Some(span) = module_record.export_default {
ctx.diagnostic(ExportDiagnostic::MultipleNamedExport(span, "default".into()));
}
}
for span in &module_record.export_default_duplicated {
ctx.diagnostic(ExportDiagnostic::MultipleNamedExport(*span, "default".into()));
}
}
}
fn walk_exported_recursive(
module_record: &ModuleRecord,
result: &mut FxHashSet<CompactStr>,
visited: &mut FxHashSet<PathBuf>,
) {
let path = &module_record.resolved_absolute_path;
if path.components().any(|c| match c {
std::path::Component::Normal(p) => p == std::ffi::OsStr::new("node_modules"),
_ => false,
}) {
return;
}
if !visited.insert(path.clone()) {
return;
}
for name in module_record.exported_bindings.keys() {
result.insert(name.clone());
}
for export_entry in &module_record.star_export_entries {
let Some(module_request) = &export_entry.module_request else {
continue;
};
let Some(remote_module_record_ref) =
module_record.loaded_modules.get(module_request.name())
else {
continue;
};
walk_exported_recursive(remote_module_record_ref.value(), result, visited);
}
}
#[test]
fn test() {
use crate::tester::Tester;
{
let pass = vec![
(r#"import "./malformed.js""#),
(r#"var foo = "foo"; export default foo;"#),
(r#"export var foo = "foo"; export var bar = "bar";"#),
(r#"export var foo = "foo", bar = "bar";"#),
("export var { foo, bar } = object;"),
("export var [ foo, bar ] = array;"),
("let foo; export { foo, foo as bar }"),
(r#"let bar; export { bar }; export * from "./export-all""#),
(r#"export * from "./export-all""#),
(r#"export * from "./does-not-exist""#),
(r#"export default foo; export * from "./bar""#),
// SYNTAX_CASES doesn't need to be tested
("
import * as A from './named-export-collision/a';
import * as B from './named-export-collision/b';
export { A, B };
"),
("
export * as A from './named-export-collision/a';
export * as B from './named-export-collision/b';
"),
("
export default function foo(param: string): boolean;
export default function foo(param: string, param1: number): boolean;
export default function foo(param: string, param1?: number): boolean {
return param && param1;
}
// "),
// Typescript
("
export const Foo = 1;
export type Foo = number;
"),
("
export const Foo = 1;
export interface Foo {}
"),
("
export function fff(a: string);
export function fff(a: number);
"),
("
export function fff(a: string);
export function fff(a: number);
export function fff(a: string|number) {};
"),
("
export const Bar = 1;
export namespace Foo {
export const Bar = 1;
}
"),
("
export type Bar = string;
export namespace Foo {
export type Bar = string;
}
"),
("
export const Bar = 1;
export type Bar = string;
export namespace Foo {
export const Bar = 1;
export type Bar = string;
}
"),
("
export namespace Foo {
export const Foo = 1;
export namespace Bar {
export const Foo = 2;
}
export namespace Baz {
export const Foo = 3;
}
}
"),
("
export class Foo { }
export namespace Foo { }
export namespace Foo {
export class Bar {}
}
"),
("
export function Foo();
export namespace Foo { }
"),
("
export function Foo(a: string);
export namespace Foo { }
"),
("
export function Foo(a: string);
export function Foo(a: number);
export namespace Foo { }
"),
("
export enum Foo { }
export namespace Foo { }
"),
(r#"export * from "./file1.ts""#),
("
export * as A from './named-export-collision/a';
export * as B from './named-export-collision/b';
"),
(r#"
declare module "a" {
const Foo = 1;
export {Foo as default};
}
declare module "b" {
const Bar = 2;
export {Bar as default};
}
"#),
(r#"
declare module "a" {
const Foo = 1;
export {Foo as default};
}
const Bar = 2;
export {Bar as default};
"#),
];
let fail = vec![
(r#"let foo; export { foo }; export * from "./export-all""#),
// (r#"export * from "./malformed.js""#),
// This case has been comment out in eslint-plugin-import
// https://github.com/import-js/eslint-plugin-import/blob/7a21f7e10f18c04473faadca94928af6b8e28009/tests/src/rules/export.js#L101-L109
// (r#"export * from "./default-export""#),
(r#"let foo; export { foo as "foo" }; export * from "./export-all""#),
("
export type Foo = string;
export type Foo = number;
"),
("
export const a = 1
export namespace Foo {
export const a = 2;
export const a = 3;
}
"),
// ("
// declare module 'foo' {
// const Foo = 1;
// export default Foo;
// export default Foo;
// }
// "),
("
export namespace Foo {
export namespace Bar {
export const Foo = 1;
export const Foo = 2;
}
export namespace Baz {
export const Bar = 3;
export const Bar = 4;
}
}
"),
("
export class Foo { }
export class Foo { }
export namespace Foo { }
"),
// ("
// export enum Foo { }
// export enum Foo { }
// export namespace Foo { }
// "),
("
export enum Foo { }
export class Foo { }
export namespace Foo { }
"),
("
export const Foo = 'bar';
export class Foo { }
export namespace Foo { }
"),
// ("
// export function Foo();
// export class Foo { }
// export namespace Foo { }
// "),
// ("
// export const Foo = 'bar';
// export function Foo();
// export namespace Foo { }
// "),
// ("
// export const Foo = 'bar';
// export namespace Foo { }
// "),
(r#"
// declare module "a" {
// const Foo = 1;
// export {Foo as default};
// }
const Bar = 2;
export {Bar as default};
const Baz = 3;
export {Baz as default};
"#),
];
Tester::new(Export::NAME, pass, fail)
.with_import_plugin(true)
.change_rule_path("index.ts")
.test_and_snapshot();
}
{
let pass = vec!["export * from './module'"];
let fail = vec![];
Tester::new(Export::NAME, pass, fail)
.with_import_plugin(true)
.change_rule_path("export-star-4/index.js")
.test();
}
}