useConsistentArrayType

TypeScript and TSX

摘要

¥Summary

规则生效日期：v1.5.0

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

¥Diagnostic Category: lint/style/useConsistentArrayType
此规则包含 unsafe 修复程序。

¥This rule has an unsafe fix.
此规则的默认严重级别为 information。

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

¥Sources:
- 与 @typescript-eslint/array-type 相同
  
  ¥Same as @typescript-eslint/array-type

如何配置

¥How to configure

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

描述

¥Description

要求一致使用 T[] 或 Array<T>

¥Require consistently using either T[] or Array<T>

TypeScript 提供了两种定义数组类型的等效方法：T[] 和 Array<T>。这两种风格在功能上是等效的。在整个代码库中一致使用相同的样式可使开发者更轻松地阅读和理解数组类型。

¥TypeScript provides two equivalent ways to define an array type: T[] and Array<T>. The two styles are functionally equivalent. Using the same style consistently across your codebase makes it easier for developers to read and understand array types.

示例

¥Example

无效

¥Invalid

1
let invalid: Array<foo>;

code-block.ts:1:14 lint/style/useConsistentArrayType  FIXABLE  ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ℹ Use shorthand T[] syntax instead of Array<T> syntax.
  
  > 1 │ let invalid: Array<foo>;
      │              ^^^^^^^^^^
    2 │ 
  
  ℹ Unsafe fix: Use shorthand T[] syntax to replace
  
    1   │ - let·invalid:·Array<foo>;
      1 │ + let·invalid:·foo[];
    2 2 │

1
let invalid: Promise<Array<string>>;

code-block.ts:1:22 lint/style/useConsistentArrayType  FIXABLE  ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ℹ Use shorthand T[] syntax instead of Array<T> syntax.
  
  > 1 │ let invalid: Promise<Array<string>>;
      │                      ^^^^^^^^^^^^^
    2 │ 
  
  ℹ Unsafe fix: Use shorthand T[] syntax to replace
  
    1   │ - let·invalid:·Promise<Array<string>>;
      1 │ + let·invalid:·Promise<string[]>;
    2 2 │

1
let invalid3: Array<Foo<Bar>>;

code-block.ts:1:15 lint/style/useConsistentArrayType  FIXABLE  ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ℹ Use shorthand T[] syntax instead of Array<T> syntax.
  
  > 1 │ let invalid3: Array<Foo<Bar>>;
      │               ^^^^^^^^^^^^^^^
    2 │ 
  
  ℹ Unsafe fix: Use shorthand T[] syntax to replace
  
    1   │ - let·invalid3:·Array<Foo<Bar>>;
      1 │ + let·invalid3:·Foo<Bar>[];
    2 2 │

有效

¥Valid

1
const valid: Array<string | number> = ['a', 'b'];
2
const valid: Array<{ prop: string }> = [{ prop: 'a' }];
3
const valid: Array<() => void> = [() => {}];
4
const valid: MyType[] = ['a', 'b'];
5
const valid: string[] = ['a', 'b'];
6
const valid: readonly string[] = ['a', 'b'];

选项

¥Options

使用以下选项指定要使用的数组声明语法。

¥Use the options to specify the syntax of array declarations to use.

1
{
2
  "linter": {
3
    "rules": {
4
      "style": {
5
        "useConsistentArrayType": {
6
          "options": {
7
            "syntax": "shorthand"
8
          }
9
        }
10
      }
11
    }
12
  }
13
}

syntax

使用的语法：

¥The syntax to use:

generic：数组声明将转换为 Array<T> 或 ReadonlyArray<T>

¥generic: array declarations will be converted to Array<T> or ReadonlyArray<T>
shorthand：数组声明将转换为 T[] 或 readonly T[]

¥shorthand: array declarations will be converted to T[] or readonly T[]

默认：shorthand

¥Default: shorthand

useConsistentArrayType

摘要

如何配置

描述

示例

无效

有效

选项

syntax

相关链接