useExportType

TypeScript and TSX

摘要

¥Summary

规则生效日期：v1.5.0

¥Rule available since: v1.5.0
诊断类别：lint/style/useExportType

¥Diagnostic Category: lint/style/useExportType
此规则为推荐规则，默认启用。

¥This rule is recommended, which means is enabled by default.
此规则包含 safe 修复程序。

¥This rule has a safe fix.
此规则的默认严重级别为 warning。

¥The default severity of this rule is warning.
来源：

¥Sources:
- 灵感来自 @typescript-eslint/consistent-type-exports
  
  ¥Inspired from @typescript-eslint/consistent-type-exports

如何配置

¥How to configure

1
{
2
  "linter": {
3
    "rules": {
4
      "style": {
5
        "useExportType": "error"
6
      }
7
    }
8
  }
9
}

描述

¥Description

提倡使用 export type 作为类型。

¥Promotes the use of export type for types.

TypeScript 允许在 export 类型上添加 type 关键字，以表明运行时不存在 export 类型。这允许编译器安全地丢弃类型的导出，而无需查找其定义。

¥TypeScript allows adding the type keyword on an export to indicate that the export doesn’t exist at runtime. This allows compilers to safely drop exports of types without looking for their definition.

该规则确保使用仅类型的 export 导出类型。它还将内联类型导出分组到分组的 export type 中。

¥The rule ensures that types are exported using a type-only export. It also groups inline type exports into a grouped export type.

示例

¥Examples

无效

¥Invalid

1
interface I {}
2
export { I };

code-block.ts:2:8 lint/style/useExportType  FIXABLE  ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ⚠ All exports are only types.
  
    1 │ interface I {}
  > 2 │ export { I };
      │        ^^^^^^
    3 │ 
  
  ℹ Using export type allows compilers to safely drop exports of types without looking for their definition.
  
  ℹ Safe fix: Use export type.
  
    2 │ export·type·{·I·};
      │        +++++

1
type T = number;
2
export { T };

code-block.ts:2:8 lint/style/useExportType  FIXABLE  ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ⚠ All exports are only types.
  
    1 │ type T = number;
  > 2 │ export { T };
      │        ^^^^^^
    3 │ 
  
  ℹ Using export type allows compilers to safely drop exports of types without looking for their definition.
  
  ℹ Safe fix: Use export type.
  
    2 │ export·type·{·T·};
      │        +++++

1
import type { T } from "./mod.js";
2
export { T };

code-block.ts:2:8 lint/style/useExportType  FIXABLE  ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ⚠ All exports are only types.
  
    1 │ import type { T } from “./mod.js”;
  > 2 │ export { T };
      │        ^^^^^^
    3 │ 
  
  ℹ Using export type allows compilers to safely drop exports of types without looking for their definition.
  
  ℹ Safe fix: Use export type.
  
    2 │ export·type·{·T·};
      │        +++++

1
export { type X, type Y };

code-block.ts:1:8 lint/style/useExportType  FIXABLE  ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ⚠ All exports are only types.
  
  > 1 │ export { type X, type Y };
      │        ^^^^^^^^^^^^^^^^^^^
    2 │ 
  
  ℹ Using export type allows compilers to safely drop exports of types without looking for their definition.
  
  ℹ Safe fix: Use export type.
  
    1   │ - export·{·type·X,·type·Y·};
      1 │ + export·type·{·X,·Y·};
    2 2 │

有效

¥Valid

1
class C {}
2
function f() {}
3
export { C, f };

此规则仅检查文件中定义的标识符。它不会对在重新导出子句中作为值导出的类型发出警告，例如：

¥This rules checks only the identifiers that are defined in a file. It doesn’t warn against a type exported as a value in a re-export clause such as:

1
export { TypeA } from "./mod.ts"

useExportType

摘要

如何配置

描述

示例

无效

有效

相关链接