{ "@typescript-eslint/adjacent-overload-signatures": { "name": "@typescript-eslint/adjacent-overload-signatures", "value": "error", "description": "重载的函数必须写在一起", "reason": "增加可读性", "badExample": "declare namespace NSFoo1 {\n export function foo(s: string): void;\n export function foo(n: number): void;\n export function bar(): void;\n eslint(@typescript-eslint/adjacent-overload-signatures)\">export function foo(sn: string | number): void;\n}\n\ntype TypeFoo1 = {\n foo(s: string): void;\n foo(n: number): void;\n bar(): void;\n eslint(@typescript-eslint/adjacent-overload-signatures)\">foo(sn: string | number): void;\n};\n\ninterface IFoo1 {\n foo(s: string): void;\n foo(n: number): void;\n bar(): void;\n eslint(@typescript-eslint/adjacent-overload-signatures)\">foo(sn: string | number): void;\n}", "goodExample": "declare namespace NSFoo2 {\n export function foo(s: string): void;\n export function foo(n: number): void;\n export function foo(sn: string | number): void;\n export function bar(): void;\n}\n\ntype TypeFoo2 = {\n foo(s: string): void;\n foo(n: number): void;\n foo(sn: string | number): void;\n bar(): void;\n};\n\ninterface IFoo2 {\n foo(s: string): void;\n foo(n: number): void;\n foo(sn: string | number): void;\n bar(): void;\n}", "fixable": false, "extendsBaseRule": "", "requiresTypeChecking": false }, "@typescript-eslint/array-type": { "name": "@typescript-eslint/array-type", "value": "off", "description": "限制数组类型必须使用 Array 或 T[]", "reason": "允许灵活运用两者", "badExample": "", "goodExample": "", "fixable": true, "extendsBaseRule": "", "requiresTypeChecking": false }, "@typescript-eslint/await-thenable": { "name": "@typescript-eslint/await-thenable", "value": "off", "description": "禁止对没有 then 方法的对象使用 await", "reason": "", "badExample": "", "goodExample": "", "fixable": false, "extendsBaseRule": "", "requiresTypeChecking": true }, "@typescript-eslint/ban-ts-comment": { "name": "@typescript-eslint/ban-ts-comment", "value": "off", "description": "禁止使用 // @ts-ignore // @ts-nocheck // @ts-check", "reason": "这种注释本身就是对特殊代码的说明", "badExample": "", "goodExample": "", "fixable": false, "extendsBaseRule": "", "requiresTypeChecking": false }, "@typescript-eslint/ban-tslint-comment": { "name": "@typescript-eslint/ban-tslint-comment", "value": "off", "description": "禁止使用类似 tslint:disable-next-line 这样的注释", "reason": "", "badExample": "", "goodExample": "", "fixable": true, "extendsBaseRule": "", "requiresTypeChecking": false }, "@typescript-eslint/ban-types": { "name": "@typescript-eslint/ban-types", "value": "off", "description": "禁止使用指定的类型", "reason": "", "badExample": "", "goodExample": "", "fixable": true, "extendsBaseRule": "", "requiresTypeChecking": false }, "@typescript-eslint/class-literal-property-style": { "name": "@typescript-eslint/class-literal-property-style", "value": ["error", "fields"], "description": "类的只读属性若是一个字面量，则必须使用只读属性而不是 getter", "reason": "", "badExample": "class Foo1 {\n public get eslint(@typescript-eslint/class-literal-property-style)\">bar() {\n return 1;\n }\n}", "goodExample": "class Foo2 {\n public readonly bar = 1;\n}", "fixable": true, "extendsBaseRule": "", "requiresTypeChecking": false }, "@typescript-eslint/consistent-indexed-object-style": { "name": "@typescript-eslint/consistent-indexed-object-style", "value": "off", "description": "必须使用内置的 Record 来描述仅包含可索引成员的接口", "reason": "", "badExample": "", "goodExample": "", "fixable": true, "extendsBaseRule": "", "requiresTypeChecking": false }, "@typescript-eslint/consistent-type-assertions": { "name": "@typescript-eslint/consistent-type-assertions", "value": ["error", { "assertionStyle": "as", "objectLiteralTypeAssertions": "never" }], "description": "类型断言必须使用 as Type，禁止使用 ，禁止对对象字面量进行类型断言（断言成 any 是允许的）", "reason": " 容易被理解为 jsx", "badExample": "let bar1: string | number;\nconst foo1 = eslint(@typescript-eslint/consistent-type-assertions)\"><string>bar1;\n\nconst baz1 = eslint(@typescript-eslint/consistent-type-assertions)\">{\n bar: 1,\n} as object;", "goodExample": "let bar2: string | number;\nconst foo2 = bar2 as string;\n\nconst baz2 = {\n bar: 1,\n} as any;", "fixable": false, "extendsBaseRule": "", "requiresTypeChecking": false }, "@typescript-eslint/consistent-type-definitions": { "name": "@typescript-eslint/consistent-type-definitions", "value": ["error", "interface"], "description": "优先使用 interface 而不是 type", "reason": "interface 可以 implement, extend 和 merge", "badExample": "type eslint(@typescript-eslint/consistent-type-definitions)\">Foo1 = {\n foo: string;\n};", "goodExample": "interface Foo2 {\n foo: string;\n}", "fixable": true, "extendsBaseRule": "", "requiresTypeChecking": false }, "@typescript-eslint/consistent-type-imports": { "name": "@typescript-eslint/consistent-type-imports", "value": "off", "description": "必须使用 import type 导入类型", "reason": "", "badExample": "", "goodExample": "", "fixable": true, "extendsBaseRule": "", "requiresTypeChecking": false }, "@typescript-eslint/default-param-last": { "name": "@typescript-eslint/default-param-last", "value": "off", "description": "有默认值或可选的参数必须放到最后", "reason": "", "badExample": "", "goodExample": "", "fixable": false, "extendsBaseRule": "default-param-last", "requiresTypeChecking": false }, "@typescript-eslint/dot-notation": { "name": "@typescript-eslint/dot-notation", "value": "off", "description": "禁止使用 foo['bar']，必须写成 foo.bar", "reason": "当需要写一系列属性的时候，可以更统一", "badExample": "", "goodExample": "", "fixable": true, "extendsBaseRule": "dot-notation", "requiresTypeChecking": true }, "@typescript-eslint/explicit-function-return-type": { "name": "@typescript-eslint/explicit-function-return-type", "value": "off", "description": "函数返回值必须与声明的类型一致", "reason": "编译阶段检查就足够了", "badExample": "", "goodExample": "", "fixable": false, "extendsBaseRule": "", "requiresTypeChecking": false }, "@typescript-eslint/explicit-member-accessibility": { "name": "@typescript-eslint/explicit-member-accessibility", "value": "error", "description": "必须设置类的成员的可访问性", "reason": "将不需要公开的成员设为私有的，可以增强代码的可理解性，对文档输出也很友好", "badExample": "class Foo2 {\n eslint(@typescript-eslint/explicit-member-accessibility)\">static foo = 'foo';\n eslint(@typescript-eslint/explicit-member-accessibility)\">static getFoo() {\n return Foo2.foo;\n }\n eslint(@typescript-eslint/explicit-member-accessibility)\">constructor() {}\n eslint(@typescript-eslint/explicit-member-accessibility)\">bar = 'bar';\n eslint(@typescript-eslint/explicit-member-accessibility)\">getBar() {}\n eslint(@typescript-eslint/explicit-member-accessibility)\">get baz() {\n return 'baz';\n }\n eslint(@typescript-eslint/explicit-member-accessibility)\">set baz(value) {\n console.log(value);\n }\n}", "goodExample": "class Foo2 {\n private static foo = 'foo';\n public static getFoo() {\n return Foo2.foo;\n }\n public constructor() {}\n protected bar = 'bar';\n public getBar() {}\n public get baz() {\n return 'baz';\n }\n public set baz(value) {\n console.log(value);\n }\n}", "fixable": true, "extendsBaseRule": "", "requiresTypeChecking": false }, "@typescript-eslint/explicit-module-boundary-types": { "name": "@typescript-eslint/explicit-module-boundary-types", "value": "off", "description": "导出的函数或类中的 public 方法必须定义输入输出参数的类型", "reason": "", "badExample": "", "goodExample": "", "fixable": false, "extendsBaseRule": "", "requiresTypeChecking": false }, "@typescript-eslint/init-declarations": { "name": "@typescript-eslint/init-declarations", "value": "off", "description": "变量必须在定义的时候赋值", "reason": "", "badExample": "", "goodExample": "", "fixable": false, "extendsBaseRule": "init-declarations", "requiresTypeChecking": false }, "@typescript-eslint/lines-between-class-members": { "name": "@typescript-eslint/lines-between-class-members", "value": "off", "description": "类的成员之间是否需要空行", "reason": "有时为了紧凑需要挨在一起，有时为了可读性需要空一行", "badExample": "", "goodExample": "", "fixable": false, "extendsBaseRule": "lines-between-class-members", "requiresTypeChecking": false }, "@typescript-eslint/member-ordering": { "name": "@typescript-eslint/member-ordering", "value": [ "error", { "default": [ "public-static-field", "protected-static-field", "private-static-field", "static-field", "public-static-method", "protected-static-method", "private-static-method", "static-method", "public-instance-field", "protected-instance-field", "private-instance-field", "public-field", "protected-field", "private-field", "instance-field", "field", "constructor", "public-instance-method", "protected-instance-method", "private-instance-method", "public-method", "protected-method", "private-method", "instance-method", "method" ] } ], "description": "指定类成员的排序规则", "reason": "优先级：\n1. static > instance\n2. field > constructor > method\n3. public > protected > private", "badExample": "class Foo1 {\n private getBar3() {\n return this.bar3;\n }\n eslint(@typescript-eslint/member-ordering)\">protected getBar2() {}\n eslint(@typescript-eslint/member-ordering)\">public getBar1() {}\n eslint(@typescript-eslint/member-ordering)\">public constructor() {\n console.log(Foo1.getFoo3());\n console.log(this.getBar3());\n }\n eslint(@typescript-eslint/member-ordering)\">private bar3 = 'bar3';\n eslint(@typescript-eslint/member-ordering)\">protected bar2 = 'bar2';\n eslint(@typescript-eslint/member-ordering)\">public bar1 = 'bar1';\n eslint(@typescript-eslint/member-ordering)\">private static getFoo3() {\n return Foo1.foo3;\n }\n eslint(@typescript-eslint/member-ordering)\">protected static getFoo2() {}\n eslint(@typescript-eslint/member-ordering)\">public static getFoo1() {}\n eslint(@typescript-eslint/member-ordering)\">private static foo3 = 'foo3';\n eslint(@typescript-eslint/member-ordering)\">protected static foo2 = 'foo2';\n eslint(@typescript-eslint/member-ordering)\">public static foo1 = 'foo1';\n}", "goodExample": "class Foo2 {\n public static foo1 = 'foo1';\n protected static foo2 = 'foo2';\n private static foo3 = 'foo3';\n public static getFoo1() {}\n protected static getFoo2() {}\n private static getFoo3() {\n return Foo2.foo3;\n }\n public bar1 = 'bar1';\n protected bar2 = 'bar2';\n private bar3 = 'bar3';\n public constructor() {\n console.log(Foo2.getFoo3());\n console.log(this.getBar3());\n }\n public getBar1() {}\n protected getBar2() {}\n private getBar3() {\n return this.bar3;\n }\n}", "fixable": false, "extendsBaseRule": "", "requiresTypeChecking": false }, "@typescript-eslint/method-signature-style": { "name": "@typescript-eslint/method-signature-style", "value": "error", "description": "接口中的方法必须用属性的方式定义", "reason": "配置了 strictFunctionTypes 之后，用属性的方式定义方法可以获得更严格的检查", "badExample": "interface Foo1 {\n eslint(@typescript-eslint/method-signature-style)\">bar(): number;\n}", "goodExample": "interface Foo1 {\n bar: () => number;\n}", "fixable": true, "extendsBaseRule": "", "requiresTypeChecking": false }, "@typescript-eslint/naming-convention": { "name": "@typescript-eslint/naming-convention", "value": "off", "description": "限制各种变量或类型的命名规则", "reason": "", "badExample": "", "goodExample": "", "fixable": false, "extendsBaseRule": "", "requiresTypeChecking": true }, "@typescript-eslint/no-array-constructor": { "name": "@typescript-eslint/no-array-constructor", "value": "off", "description": "禁止使用 Array 构造函数", "reason": "", "badExample": "", "goodExample": "", "fixable": true, "extendsBaseRule": "no-array-constructor", "requiresTypeChecking": false }, "@typescript-eslint/no-base-to-string": { "name": "@typescript-eslint/no-base-to-string", "value": "off", "description": "禁止滥用 toString 方法", "reason": "", "badExample": "", "goodExample": "", "fixable": false, "extendsBaseRule": "", "requiresTypeChecking": true }, "@typescript-eslint/no-confusing-non-null-assertion": { "name": "@typescript-eslint/no-confusing-non-null-assertion", "value": "off", "description": "禁止使用容易混淆的非空断言", "reason": "", "badExample": "", "goodExample": "", "fixable": true, "extendsBaseRule": "", "requiresTypeChecking": false }, "@typescript-eslint/no-dupe-class-members": { "name": "@typescript-eslint/no-dupe-class-members", "value": "off", "description": "禁止重复定义类的成员", "reason": "编译阶段就会报错了", "badExample": "", "goodExample": "", "fixable": false, "extendsBaseRule": "no-dupe-class-members", "requiresTypeChecking": false }, "@typescript-eslint/no-duplicate-imports": { "name": "@typescript-eslint/no-duplicate-imports", "value": "error", "description": "禁止重复导入模块", "reason": "", "badExample": "import { readFile } from 'fs';\neslint(@typescript-eslint/no-duplicate-imports)\">import { writeFile } from 'fs';", "goodExample": "import { readFile, writeFile } from 'fs';", "fixable": false, "extendsBaseRule": "no-duplicate-imports", "requiresTypeChecking": false }, "@typescript-eslint/no-dynamic-delete": { "name": "@typescript-eslint/no-dynamic-delete", "value": "off", "description": "禁止 delete 时传入的 key 是动态的", "reason": "", "badExample": "", "goodExample": "", "fixable": true, "extendsBaseRule": "", "requiresTypeChecking": false }, "@typescript-eslint/no-empty-function": { "name": "@typescript-eslint/no-empty-function", "value": "off", "description": "不允许有空函数", "reason": "有时需要将一个空函数设置为某个项的默认值", "badExample": "", "goodExample": "", "fixable": false, "extendsBaseRule": "no-empty-function", "requiresTypeChecking": false }, "@typescript-eslint/no-empty-interface": { "name": "@typescript-eslint/no-empty-interface", "value": "error", "description": "禁止定义空的接口", "reason": "", "badExample": "interface eslint(@typescript-eslint/no-empty-interface)\">Foo1 {}", "goodExample": "interface Foo2 {\n foo: string;\n}", "fixable": true, "extendsBaseRule": "", "requiresTypeChecking": false }, "@typescript-eslint/no-explicit-any": { "name": "@typescript-eslint/no-explicit-any", "value": "off", "description": "禁止使用 any", "reason": "", "badExample": "", "goodExample": "", "fixable": true, "extendsBaseRule": "", "requiresTypeChecking": false }, "@typescript-eslint/no-extra-non-null-assertion": { "name": "@typescript-eslint/no-extra-non-null-assertion", "value": "off", "description": "禁止多余的 non-null 断言", "reason": "", "badExample": "", "goodExample": "", "fixable": true, "extendsBaseRule": "", "requiresTypeChecking": false }, "@typescript-eslint/no-extraneous-class": { "name": "@typescript-eslint/no-extraneous-class", "value": "off", "description": "禁止定义没必要的类，比如只有静态方法的类", "reason": "", "badExample": "", "goodExample": "", "fixable": false, "extendsBaseRule": "", "requiresTypeChecking": false }, "@typescript-eslint/no-floating-promises": { "name": "@typescript-eslint/no-floating-promises", "value": "off", "description": "禁止调用 Promise 时没有处理异常情况", "reason": "", "badExample": "", "goodExample": "", "fixable": false, "extendsBaseRule": "", "requiresTypeChecking": true }, "@typescript-eslint/no-for-in-array": { "name": "@typescript-eslint/no-for-in-array", "value": "off", "description": "禁止对 array 使用 for in 循环", "reason": "", "badExample": "", "goodExample": "", "fixable": false, "extendsBaseRule": "", "requiresTypeChecking": true }, "@typescript-eslint/no-implicit-any-catch": { "name": "@typescript-eslint/no-implicit-any-catch", "value": "off", "description": "catch 的参数必须指定具体类型", "reason": "", "badExample": "", "goodExample": "", "fixable": true, "extendsBaseRule": "", "requiresTypeChecking": false }, "@typescript-eslint/no-implied-eval": { "name": "@typescript-eslint/no-implied-eval", "value": "off", "description": "禁止使用 eval", "reason": "", "badExample": "", "goodExample": "", "fixable": false, "extendsBaseRule": "", "requiresTypeChecking": true }, "@typescript-eslint/no-inferrable-types": { "name": "@typescript-eslint/no-inferrable-types", "value": "error", "description": "禁止给一个初始化时直接赋值为 number, string 的变量显式的声明类型", "reason": "可以简化代码", "badExample": "let eslint(@typescript-eslint/no-inferrable-types)\">foo1: number = 1;\nlet eslint(@typescript-eslint/no-inferrable-types)\">bar1: string = '';", "goodExample": "const foo2 = 1;\nconst bar2 = '';", "fixable": true, "extendsBaseRule": "", "requiresTypeChecking": false }, "@typescript-eslint/no-invalid-this": { "name": "@typescript-eslint/no-invalid-this", "value": "error", "description": "禁止在类之外的地方使用 this", "reason": "只允许在 class 中使用 this", "badExample": "function foo() {\n eslint(@typescript-eslint/no-invalid-this)\">this.a = 0;\n}", "goodExample": "class Foo {\n a: number;\n constructor() {\n this.a = 0;\n }\n}", "fixable": false, "extendsBaseRule": "no-invalid-this", "requiresTypeChecking": false }, "@typescript-eslint/no-invalid-void-type": { "name": "@typescript-eslint/no-invalid-void-type", "value": "error", "description": "禁止使用无意义的 void 类型", "reason": "void 只能用在函数的返回值中", "badExample": "type Foo1 = eslint(@typescript-eslint/no-invalid-void-type)\">void;", "goodExample": "type Foo2 = () => void;", "fixable": false, "extendsBaseRule": "", "requiresTypeChecking": false }, "@typescript-eslint/no-loop-func": { "name": "@typescript-eslint/no-loop-func", "value": "off", "description": "禁止在循环内的函数内部出现循环体条件语句中定义的变量", "reason": "使用 let 就已经解决了这个问题了", "badExample": "", "goodExample": "", "fixable": false, "extendsBaseRule": "no-loop-func", "requiresTypeChecking": false }, "@typescript-eslint/no-loss-of-precision": { "name": "@typescript-eslint/no-loss-of-precision", "value": "error", "description": "禁止使用超出 js 精度范围的数字", "reason": "", "badExample": "const foo1 = eslint(@typescript-eslint/no-loss-of-precision)\">5123000000000000000000000000001;", "goodExample": "const foo2 = 12345;", "fixable": false, "extendsBaseRule": "no-loss-of-precision", "requiresTypeChecking": false }, "@typescript-eslint/no-magic-numbers": { "name": "@typescript-eslint/no-magic-numbers", "value": "off", "description": "禁止使用 magic numbers", "reason": "", "badExample": "", "goodExample": "", "fixable": false, "extendsBaseRule": "no-magic-numbers", "requiresTypeChecking": false }, "@typescript-eslint/no-misused-new": { "name": "@typescript-eslint/no-misused-new", "value": "off", "description": "禁止在接口中定义 constructor，或在类中定义 new", "reason": "", "badExample": "", "goodExample": "", "fixable": false, "extendsBaseRule": "", "requiresTypeChecking": false }, "@typescript-eslint/no-misused-promises": { "name": "@typescript-eslint/no-misused-promises", "value": "off", "description": "避免错误的使用 Promise", "reason": "", "badExample": "", "goodExample": "", "fixable": false, "extendsBaseRule": "", "requiresTypeChecking": true }, "@typescript-eslint/no-namespace": { "name": "@typescript-eslint/no-namespace", "value": ["error", { "allowDeclarations": true, "allowDefinitionFiles": true }], "description": "禁止使用 namespace 来定义命名空间", "reason": "使用 es6 引入模块，才是更标准的方式。\n但是允许使用 declare namespace ... {} 来定义外部命名空间", "badExample": "eslint(@typescript-eslint/no-namespace)\">namespace foo1 {}", "goodExample": "declare namespace foo1 {}", "fixable": false, "extendsBaseRule": "", "requiresTypeChecking": false }, "@typescript-eslint/no-non-null-asserted-optional-chain": { "name": "@typescript-eslint/no-non-null-asserted-optional-chain", "value": "error", "description": "禁止在 optional chaining 之后使用 non-null 断言（感叹号）", "reason": "optional chaining 后面的属性一定是非空的", "badExample": "let foo1: { bar: { baz: string } } | undefined;\n\nconsole.log(eslint(@typescript-eslint/no-non-null-asserted-optional-chain)\">foo1?.bar!);", "goodExample": "let foo2: { bar: { baz: string } } | undefined;\n\nconsole.log(foo2?.bar);", "fixable": false, "extendsBaseRule": "", "requiresTypeChecking": false }, "@typescript-eslint/no-non-null-assertion": { "name": "@typescript-eslint/no-non-null-assertion", "value": "off", "description": "禁止使用 non-null 断言（感叹号）", "reason": "使用 non-null 断言时就已经清楚了风险", "badExample": "", "goodExample": "", "fixable": false, "extendsBaseRule": "", "requiresTypeChecking": false }, "@typescript-eslint/no-parameter-properties": { "name": "@typescript-eslint/no-parameter-properties", "value": "error", "description": "禁止给类的构造函数的参数添加修饰符", "reason": "强制所有属性都定义到类里面，比较统一", "badExample": "class Foo1 {\n constructor(eslint(@typescript-eslint/no-parameter-properties)\">private name: string) {}\n}", "goodExample": "class Foo2 {\n constructor(name: string) {}\n}", "fixable": false, "extendsBaseRule": "", "requiresTypeChecking": false }, "@typescript-eslint/no-redeclare": { "name": "@typescript-eslint/no-redeclare", "value": "off", "description": "禁止重复定义变量", "reason": "禁用 var 之后，编译阶段就会报错了", "badExample": "", "goodExample": "", "fixable": false, "extendsBaseRule": "no-redeclare", "requiresTypeChecking": false }, "@typescript-eslint/no-require-imports": { "name": "@typescript-eslint/no-require-imports", "value": "error", "description": "禁止使用 require", "reason": "统一使用 import 来引入模块，特殊情况使用单行注释允许 require 引入", "badExample": "const fs = eslint(@typescript-eslint/no-require-imports)\">require('fs');", "goodExample": "import * as fs from 'fs';", "fixable": false, "extendsBaseRule": "", "requiresTypeChecking": false }, "@typescript-eslint/no-shadow": { "name": "@typescript-eslint/no-shadow", "value": "off", "description": "禁止变量名与上层作用域内的已定义的变量重复", "reason": "很多时候函数的形参和传参是同名的", "badExample": "", "goodExample": "", "fixable": false, "extendsBaseRule": "no-shadow", "requiresTypeChecking": false }, "@typescript-eslint/no-this-alias": { "name": "@typescript-eslint/no-this-alias", "value": ["error", { "allowDestructuring": true }], "description": "禁止将 this 赋值给其他变量，除非是解构赋值", "reason": "", "badExample": "function foo() {\n const eslint(@typescript-eslint/no-this-alias)\">self = this;\n setTimeout(function () {\n self.doWork();\n });\n}", "goodExample": "function foo() {\n const { bar } = this;\n setTimeout(() => {\n this.doWork();\n });\n}", "fixable": false, "extendsBaseRule": "", "requiresTypeChecking": false }, "@typescript-eslint/no-throw-literal": { "name": "@typescript-eslint/no-throw-literal", "value": "off", "description": "禁止 throw 字面量，必须 throw 一个 Error 对象", "reason": "", "badExample": "", "goodExample": "", "fixable": false, "extendsBaseRule": "", "requiresTypeChecking": true }, "@typescript-eslint/no-type-alias": { "name": "@typescript-eslint/no-type-alias", "value": "off", "description": "禁止使用类型别名", "reason": "", "badExample": "", "goodExample": "", "fixable": false, "extendsBaseRule": "", "requiresTypeChecking": false }, "@typescript-eslint/no-unnecessary-boolean-literal-compare": { "name": "@typescript-eslint/no-unnecessary-boolean-literal-compare", "value": "off", "description": "测试表达式中的布尔类型禁止与 true 或 false 直接比较", "reason": "", "badExample": "", "goodExample": "", "fixable": true, "extendsBaseRule": "", "requiresTypeChecking": true }, "@typescript-eslint/no-unnecessary-condition": { "name": "@typescript-eslint/no-unnecessary-condition", "value": "off", "description": "条件表达式禁止是永远为真（或永远为假）的", "reason": "", "badExample": "", "goodExample": "", "fixable": true, "extendsBaseRule": "", "requiresTypeChecking": true }, "@typescript-eslint/no-unnecessary-qualifier": { "name": "@typescript-eslint/no-unnecessary-qualifier", "value": "off", "description": "在命名空间中，可以直接使用内部变量，不需要添加命名空间前缀", "reason": "", "badExample": "", "goodExample": "", "fixable": true, "extendsBaseRule": "", "requiresTypeChecking": true }, "@typescript-eslint/no-unnecessary-type-arguments": { "name": "@typescript-eslint/no-unnecessary-type-arguments", "value": "off", "description": "禁止范型的类型有默认值时，将范型设置为该默认值", "reason": "", "badExample": "", "goodExample": "", "fixable": true, "extendsBaseRule": "", "requiresTypeChecking": true }, "@typescript-eslint/no-unnecessary-type-assertion": { "name": "@typescript-eslint/no-unnecessary-type-assertion", "value": "off", "description": "禁止无用的类型断言", "reason": "", "badExample": "", "goodExample": "", "fixable": true, "extendsBaseRule": "", "requiresTypeChecking": true }, "@typescript-eslint/no-unsafe-assignment": { "name": "@typescript-eslint/no-unsafe-assignment", "value": "off", "description": "禁止将变量或属性的类型设置为 any", "reason": "", "badExample": "", "goodExample": "", "fixable": false, "extendsBaseRule": "", "requiresTypeChecking": true }, "@typescript-eslint/no-unsafe-call": { "name": "@typescript-eslint/no-unsafe-call", "value": "off", "description": "禁止调用 any 类型的变量上的方法", "reason": "", "badExample": "", "goodExample": "", "fixable": false, "extendsBaseRule": "", "requiresTypeChecking": true }, "@typescript-eslint/no-unsafe-member-access": { "name": "@typescript-eslint/no-unsafe-member-access", "value": "off", "description": "禁止获取 any 类型的变量中的属性", "reason": "", "badExample": "", "goodExample": "", "fixable": false, "extendsBaseRule": "", "requiresTypeChecking": true }, "@typescript-eslint/no-unsafe-return": { "name": "@typescript-eslint/no-unsafe-return", "value": "off", "description": "禁止函数的返回值的类型是 any", "reason": "", "badExample": "", "goodExample": "", "fixable": false, "extendsBaseRule": "", "requiresTypeChecking": true }, "@typescript-eslint/no-unused-expressions": { "name": "@typescript-eslint/no-unused-expressions", "value": ["error", { "allowShortCircuit": true, "allowTernary": true, "allowTaggedTemplates": true }], "description": "禁止无用的表达式", "reason": "", "badExample": "declare const foo1: any;\ndeclare const bar1: any;\ndeclare const baz1: any;\neslint(@typescript-eslint/no-unused-expressions)\">1;\neslint(@typescript-eslint/no-unused-expressions)\">foo1;\neslint(@typescript-eslint/no-unused-expressions)\">('foo1');\neslint(@typescript-eslint/no-unused-expressions)\">foo1 && bar1;\neslint(@typescript-eslint/no-unused-expressions)\">foo1 || bar1;\neslint(@typescript-eslint/no-unused-expressions)\">foo1 ? bar1 : baz1;\neslint(@typescript-eslint/no-unused-expressions)\">`bar1`;", "goodExample": "'use strict';\ndeclare const foo2: any;\ndeclare const bar2: any;\ndeclare const baz2: any;\nfoo2 && bar2();\nfoo2 || bar2();\nfoo2 ? bar2() : baz2();\nfoo2`bar2`;", "fixable": false, "extendsBaseRule": "no-unused-expressions", "requiresTypeChecking": false }, "@typescript-eslint/no-unused-vars": { "name": "@typescript-eslint/no-unused-vars", "value": "off", "description": "已定义的变量必须使用", "reason": "编译阶段检查就足够了", "badExample": "", "goodExample": "", "fixable": false, "extendsBaseRule": "no-unused-vars", "requiresTypeChecking": false }, "@typescript-eslint/no-use-before-define": { "name": "@typescript-eslint/no-use-before-define", "value": "off", "description": "禁止在定义变量之前就使用它", "reason": "编译阶段检查就足够了", "badExample": "", "goodExample": "", "fixable": false, "extendsBaseRule": "no-use-before-define", "requiresTypeChecking": false }, "@typescript-eslint/no-useless-constructor": { "name": "@typescript-eslint/no-useless-constructor", "value": "error", "description": "禁止出现没必要的 constructor", "reason": "", "badExample": "class Foo1 {\n eslint(@typescript-eslint/no-useless-constructor)\">constructor() {}\n}\n\nclass Bar1 extends Foo1 {\n eslint(@typescript-eslint/no-useless-constructor)\">constructor() {\n super();\n }\n}", "goodExample": "class Foo2 {\n constructor() {\n this.doSomething();\n }\n doSomething() {}\n}\n\nclass Bar2 extends Foo1 {\n constructor() {\n super();\n this.doSomething();\n }\n doSomething() {}\n}", "fixable": false, "extendsBaseRule": "no-useless-constructor", "requiresTypeChecking": false }, "@typescript-eslint/no-var-requires": { "name": "@typescript-eslint/no-var-requires", "value": "off", "description": "禁止使用 require 来引入模块", "reason": "no-require-imports 规则已经约束了 require", "badExample": "", "goodExample": "", "fixable": false, "extendsBaseRule": "", "requiresTypeChecking": false }, "@typescript-eslint/prefer-as-const": { "name": "@typescript-eslint/prefer-as-const", "value": "off", "description": "使用 as const 替代 as 'bar'", "reason": "as const 是新语法，不是很常见", "badExample": "", "goodExample": "", "fixable": true, "extendsBaseRule": "", "requiresTypeChecking": false }, "@typescript-eslint/prefer-enum-initializers": { "name": "@typescript-eslint/prefer-enum-initializers", "value": "off", "description": "枚举值必须初始化", "reason": "", "badExample": "", "goodExample": "", "fixable": false, "extendsBaseRule": "", "requiresTypeChecking": false }, "@typescript-eslint/prefer-for-of": { "name": "@typescript-eslint/prefer-for-of", "value": "error", "description": "使用 for 循环遍历数组时，如果索引仅用于获取成员，则必须使用 for of 循环替代 for 循环", "reason": "for of 循环更加易读", "badExample": "const arr1 = [1, 2, 3];\n\neslint(@typescript-eslint/prefer-for-of)\">for (let i = 0; i < arr1.length; i++) {\n console.log(arr1[i]);\n}", "goodExample": "const arr2 = [1, 2, 3];\n\nfor (const x of arr2) {\n console.log(x);\n}\n\nfor (let i = 0; i < arr2.length; i++) {\n // i is used to write to arr, so for-of could not be used.\n arr2[i] = 0;\n}\n\nfor (let i = 0; i < arr2.length; i++) {\n // i is used independent of arr, so for-of could not be used.\n console.log(i, arr2[i]);\n}", "fixable": false, "extendsBaseRule": "", "requiresTypeChecking": false }, "@typescript-eslint/prefer-function-type": { "name": "@typescript-eslint/prefer-function-type", "value": "error", "description": "使用函数类型别名替代包含函数调用声明的接口", "reason": "", "badExample": "interface Foo1 {\n eslint(@typescript-eslint/prefer-function-type)\">(): string;\n}", "goodExample": "type Foo2 = () => string;", "fixable": true, "extendsBaseRule": "", "requiresTypeChecking": false }, "@typescript-eslint/prefer-includes": { "name": "@typescript-eslint/prefer-includes", "value": "off", "description": "使用 includes 而不是 indexOf", "reason": "", "badExample": "", "goodExample": "", "fixable": true, "extendsBaseRule": "", "requiresTypeChecking": true }, "@typescript-eslint/prefer-literal-enum-member": { "name": "@typescript-eslint/prefer-literal-enum-member", "value": "off", "description": "枚举类型的值必须是字面量，禁止是计算值", "reason": "编译阶段检查就足够了", "badExample": "", "goodExample": "", "fixable": false, "extendsBaseRule": "", "requiresTypeChecking": false }, "@typescript-eslint/prefer-namespace-keyword": { "name": "@typescript-eslint/prefer-namespace-keyword", "value": "error", "description": "禁止使用 module 来定义命名空间", "reason": "module 已成为 js 的关键字", "badExample": "eslint(@typescript-eslint/prefer-namespace-keyword)\">module Foo1 {}", "goodExample": "namespace Foo2 {}", "fixable": true, "extendsBaseRule": "", "requiresTypeChecking": false }, "@typescript-eslint/prefer-nullish-coalescing": { "name": "@typescript-eslint/prefer-nullish-coalescing", "value": "off", "description": "使用 ?? 替代 ||", "reason": "", "badExample": "", "goodExample": "", "fixable": false, "extendsBaseRule": "", "requiresTypeChecking": true }, "@typescript-eslint/prefer-optional-chain": { "name": "@typescript-eslint/prefer-optional-chain", "value": "error", "description": "使用 optional chaining 替代 &&", "reason": "", "badExample": "let foo1: any;\nconsole.log(eslint(@typescript-eslint/prefer-optional-chain)\">foo1 && foo1.a && foo1.a.b && foo1.a.b.c);", "goodExample": "let foo2: any;\nconsole.log(foo2?.a?.b?.c);", "fixable": false, "extendsBaseRule": "", "requiresTypeChecking": false }, "@typescript-eslint/prefer-readonly": { "name": "@typescript-eslint/prefer-readonly", "value": "off", "description": "私有变量如果没有在构造函数外被赋值，则必须设为 readonly", "reason": "", "badExample": "", "goodExample": "", "fixable": true, "extendsBaseRule": "", "requiresTypeChecking": true }, "@typescript-eslint/prefer-readonly-parameter-types": { "name": "@typescript-eslint/prefer-readonly-parameter-types", "value": "off", "description": "函数的参数必须设置为 readonly", "reason": "", "badExample": "", "goodExample": "", "fixable": false, "extendsBaseRule": "", "requiresTypeChecking": true }, "@typescript-eslint/prefer-reduce-type-parameter": { "name": "@typescript-eslint/prefer-reduce-type-parameter", "value": "off", "description": "使用 reduce 方法时，必须传入范型，而不是对第二个参数使用 as", "reason": "", "badExample": "", "goodExample": "", "fixable": true, "extendsBaseRule": "", "requiresTypeChecking": true }, "@typescript-eslint/prefer-regexp-exec": { "name": "@typescript-eslint/prefer-regexp-exec", "value": "off", "description": "使用 RegExp#exec 而不是 String#match", "reason": "", "badExample": "", "goodExample": "", "fixable": false, "extendsBaseRule": "", "requiresTypeChecking": true }, "@typescript-eslint/prefer-string-starts-ends-with": { "name": "@typescript-eslint/prefer-string-starts-ends-with", "value": "off", "description": "使用 String#startsWith 而不是其他方式", "reason": "", "badExample": "", "goodExample": "", "fixable": true, "extendsBaseRule": "", "requiresTypeChecking": true }, "@typescript-eslint/prefer-ts-expect-error": { "name": "@typescript-eslint/prefer-ts-expect-error", "value": "off", "description": "当需要忽略下一行的 ts 错误时，必须使用 @ts-expect-error 而不是 @ts-ignore", "reason": "使用 @ts-expect-error 可以避免对不会报错的代码设置了 @ts-ignore", "badExample": "", "goodExample": "", "fixable": true, "extendsBaseRule": "", "requiresTypeChecking": false }, "@typescript-eslint/promise-function-async": { "name": "@typescript-eslint/promise-function-async", "value": "off", "description": "async 函数的返回值必须是 Promise", "reason": "", "badExample": "", "goodExample": "", "fixable": false, "extendsBaseRule": "", "requiresTypeChecking": true }, "@typescript-eslint/require-array-sort-compare": { "name": "@typescript-eslint/require-array-sort-compare", "value": "off", "description": "使用 sort 时必须传入比较函数", "reason": "", "badExample": "", "goodExample": "", "fixable": false, "extendsBaseRule": "", "requiresTypeChecking": true }, "@typescript-eslint/require-await": { "name": "@typescript-eslint/require-await", "value": "off", "description": "async 函数中必须存在 await 语句", "reason": "", "badExample": "", "goodExample": "", "fixable": false, "extendsBaseRule": "require-await", "requiresTypeChecking": true }, "@typescript-eslint/restrict-plus-operands": { "name": "@typescript-eslint/restrict-plus-operands", "value": "off", "description": "使用加号时，两者必须同为数字或同为字符串", "reason": "", "badExample": "", "goodExample": "", "fixable": false, "extendsBaseRule": "", "requiresTypeChecking": true }, "@typescript-eslint/restrict-template-expressions": { "name": "@typescript-eslint/restrict-template-expressions", "value": "off", "description": "模版字符串中的变量类型必须是字符串", "reason": "", "badExample": "", "goodExample": "", "fixable": false, "extendsBaseRule": "", "requiresTypeChecking": true }, "@typescript-eslint/return-await": { "name": "@typescript-eslint/return-await", "value": "off", "description": "禁止在 return 语句里使用 await", "reason": "", "badExample": "", "goodExample": "", "fixable": true, "extendsBaseRule": "no-return-await", "requiresTypeChecking": true }, "@typescript-eslint/strict-boolean-expressions": { "name": "@typescript-eslint/strict-boolean-expressions", "value": "off", "description": "条件判断必须传入布尔值", "reason": "", "badExample": "", "goodExample": "", "fixable": false, "extendsBaseRule": "", "requiresTypeChecking": true }, "@typescript-eslint/switch-exhaustiveness-check": { "name": "@typescript-eslint/switch-exhaustiveness-check", "value": "off", "description": "使用联合类型作为 switch 的对象时，必须包含每一个类型的 case", "reason": "", "badExample": "", "goodExample": "", "fixable": false, "extendsBaseRule": "", "requiresTypeChecking": true }, "@typescript-eslint/triple-slash-reference": { "name": "@typescript-eslint/triple-slash-reference", "value": ["error", { "path": "never", "types": "always", "lib": "always" }], "description": "禁止使用三斜杠导入文件", "reason": "三斜杠是已废弃的语法，但在类型声明文件中还是可以使用的", "badExample": "eslint(@typescript-eslint/triple-slash-reference)\">/// <reference path=\"./Animal\">", "goodExample": "import Animal from './Animal';", "fixable": false, "extendsBaseRule": "", "requiresTypeChecking": false }, "@typescript-eslint/typedef": { "name": "@typescript-eslint/typedef", "value": [ "error", { "arrayDestructuring": false, "arrowParameter": false, "memberVariableDeclaration": false, "objectDestructuring": false, "parameter": false, "propertyDeclaration": true, "variableDeclaration": false } ], "description": "interface 和 type 定义时必须声明成员的类型", "reason": "", "badExample": "type Foo1 = {\n eslint(@typescript-eslint/typedef)\">bar;\n eslint(@typescript-eslint/typedef)\">baz;\n};", "goodExample": "type Foo2 = {\n bar: boolean;\n baz: string;\n};", "fixable": false, "extendsBaseRule": "", "requiresTypeChecking": false }, "@typescript-eslint/unbound-method": { "name": "@typescript-eslint/unbound-method", "value": "off", "description": "方法调用时需要绑定到正确的 this 上", "reason": "", "badExample": "", "goodExample": "", "fixable": false, "extendsBaseRule": "", "requiresTypeChecking": true }, "@typescript-eslint/unified-signatures": { "name": "@typescript-eslint/unified-signatures", "value": "error", "description": "函数重载时，若能通过联合类型将两个函数的类型声明合为一个，则使用联合类型而不是两个函数声明", "reason": "", "badExample": "function foo1(x: number): void;\nfunction foo1(eslint(@typescript-eslint/unified-signatures)\">x: string): void;\nfunction foo1(x: any): any {\n return x;\n}", "goodExample": "function foo2(x: number | string): void;\nfunction foo2(x: any): any {\n return x;\n}", "fixable": false, "extendsBaseRule": "", "requiresTypeChecking": false } }