54 lines
1.5 KiB
Plaintext
54 lines
1.5 KiB
Plaintext
---
|
|
description: "Disallow empty exports that don't change anything in a module file."
|
|
---
|
|
|
|
import Tabs from '@theme/Tabs';
|
|
import TabItem from '@theme/TabItem';
|
|
|
|
> 🛑 This file is source code, not the primary documentation location! 🛑
|
|
>
|
|
> See **https://typescript-eslint.io/rules/no-useless-empty-export** for documentation.
|
|
|
|
An empty `export {}` statement is sometimes useful in TypeScript code to turn a file that would otherwise be a script file into a module file.
|
|
Per the [TypeScript Handbook Modules page](https://www.typescriptlang.org/docs/handbook/modules.html):
|
|
|
|
> In TypeScript, just as in ECMAScript 2015, any file containing a top-level import or export is considered a module.
|
|
> Conversely, a file without any top-level import or export declarations is treated as a script whose contents are available in the global scope (and therefore to modules as well).
|
|
|
|
However, an `export {}` statement does nothing if there are any other top-level import or export statements in a file.
|
|
|
|
This rule reports an `export {}` that doesn't do anything in a file already using ES modules.
|
|
|
|
## Examples
|
|
|
|
<Tabs>
|
|
<TabItem value="❌ Incorrect">
|
|
|
|
```ts
|
|
export const value = 'Hello, world!';
|
|
export {};
|
|
```
|
|
|
|
```ts
|
|
import 'some-other-module';
|
|
export {};
|
|
```
|
|
|
|
</TabItem>
|
|
<TabItem value="✅ Correct">
|
|
|
|
```ts
|
|
export const value = 'Hello, world!';
|
|
```
|
|
|
|
```ts
|
|
import 'some-other-module';
|
|
```
|
|
|
|
</TabItem>
|
|
</Tabs>
|
|
|
|
## When Not To Use It
|
|
|
|
If you don't mind an empty `export {}` at the bottom of files, you likely don't need this rule.
|