noEnum

TypeScript and TSX

摘要

¥Summary

规则生效日期：v1.9.0

¥Rule available since: v1.9.0
诊断类别：lint/style/noEnum

¥Diagnostic Category: lint/style/noEnum
此规则没有修复方案。

¥This rule doesn’t have a fix.
此规则的默认严重级别为 warning。

¥The default severity of this rule is warning.

如何配置

¥How to configure

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

描述

¥Description

禁止 TypeScript 枚举。

¥Disallow TypeScript enum.

TypeScript 枚举不是 JavaScript 的类型级扩展，如类型注释或定义。用户可能希望禁用非类型级扩展以使用仅剥离类型的打包器或编译器。

¥TypeScript enums are not a type-level extension to JavaScript like type annotations or definitions. Users may wish to disable non-type-level extensions to use bundlers or compilers that only strip types.

此规则不涵盖常量枚举，因为 noConstEnum 已经处理它们。环境上下文中的枚举（包括声明文件）也将被忽略。

¥Const enums are not covered by this rule since noConstEnum already handles them. Enums within the ambient context, including declaration files, are ignores as well.

示例

¥Examples

无效

¥Invalid

1
enum Foo {
2
    BAR = 'bar',
3
    BAZ = 'baz',
4
}

code-block.ts:1:1 lint/style/noEnum ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ⚠ Don’t use enum
  
  > 1 │ enum Foo {
      │ ^^^^^^^^^^
  > 2 │     BAR = ‘bar’,
  > 3 │     BAZ = ‘baz’,
  > 4 │ }
      │ ^
    5 │ 
  
  ℹ TypeScript enums are not a type-level extension to JavaScript like type annotations or definitions. Users may wish to disable non-type-level extensions to use bundlers or compilers that only strip types.
  
  ℹ Use JavaScript objects or TypeScript unions instead.

有效

¥Valid

1
const Foo = {
2
    BAR: 'bar',
3
    BAZ: 'baz',
4
} as const

1
type Foo = 'bar' | 'baz'

1
const enum Foo {
2
    BAR = 'bar',
3
    BAZ = 'baz',
4
}

noEnum

摘要

如何配置

描述

示例

无效

有效

相关链接