ESLint 风格

外观

@stylistic/eslint-plugin-ts ​

用于 ESLint 的 TypeScript 风格规则，从 typescript-eslint 迁移而来。

感谢所有为原始规则做出贡献的贡献者。

提示

我们建议使用 @stylistic/eslint-plugin，因为它包含 JavaScript 和 TypeScript 的规则

安装 ​

sh
npm i -D @stylistic/eslint-plugin-ts

将 @stylistic/ts 添加到您的插件列表中，并将 风格规则 的前缀从 @typescript-eslint/ 更改为 @stylistic/ts/

js
// eslint.config.js
import stylisticTs from '@stylistic/eslint-plugin-ts'
import parserTs from '@typescript-eslint/parser'

export default [
  {
    plugins: {
      '@stylistic/ts': stylisticTs
    },
    parser: parserTs,
    rules: {
      '@typescript-eslint/indent': ['error', 2],
      '@stylistic/ts/indent': ['error', 2],
      // ...
    }
  }
]
js
// .eslintrc.js
module.exports = {
  plugins: [
    '@typescript-eslint',
    '@stylistic/ts',
  ],
  parser: '@typescript-eslint/parser',
  rules: {
    '@typescript-eslint/indent': ['error', 2],
    '@stylistic/ts/indent': ['error', 2],
    // ...
  }
};

请注意，此包仅包含风格规则。您仍然需要安装 @typescript-eslint/parser 和 @typescript-eslint/eslint-plugin 来解析和 lint 您的 TypeScript 代码。

查看 迁移指南 获取更多详细信息。

规则 ​

每个规则都有表情符号表示
💼
该规则是共享配置的一部分
🔧
一些报告的问题可以通过--fix命令行选项修复
规则描述
block-spacing禁止或强制在块的开头和结尾处使用空格💼🔧
brace-style强制对块使用一致的大括号样式💼🔧
comma-dangle要求或禁止尾随逗号💼🔧
comma-spacing强制在逗号前后使用一致的空格💼🔧
func-call-spacing要求或禁止在函数标识符及其调用之间使用空格。`function-call-spacing`的别名。🔧
function-call-spacing要求或禁止在函数标识符及其调用之间使用空格🔧
indent强制一致的缩进💼🔧
key-spacing强制在类型和接口中的属性名称和类型注释之间使用一致的空格💼🔧
keyword-spacing强制在关键字前后使用一致的空格💼🔧
lines-around-comment要求在注释周围使用空行🔧
lines-between-class-members要求或禁止在类成员之间使用空行💼🔧
member-delimiter-style要求对接口和类型字面量使用特定的成员分隔符样式💼🔧
no-extra-parens禁止不必要的括号💼🔧
no-extra-semi禁止不必要的分号🔧
object-curly-spacing强制在大括号内使用一致的空格💼🔧
padding-line-between-statements要求或禁止在语句之间使用填充行🔧
quote-props要求在对象字面量、类型字面量、接口和枚举属性名称周围使用引号💼🔧
quotes强制一致地使用反引号、双引号或单引号💼🔧
semi要求或禁止使用分号而不是 ASI💼🔧
space-before-blocks强制在块之前使用一致的空格💼🔧
space-before-function-paren强制在函数括号之前使用一致的空格💼🔧
space-infix-ops要求在中缀运算符周围使用空格💼🔧
type-annotation-spacing要求在类型注释周围使用一致的空格💼🔧
总共 23 条规则。