@typescript-eslintnaming-convention：如何混合错误和警告规则

typescript

使用 @typescript-eslint/naming-convention 可以帮助我们在 typescript 项目中维护一致的命名约定。这个规则集可以帮助我们遵循命名约定，提高代码的可读性和可维护性。在实际开发中，我们有时候可能希望某些命名规则被视为警告而不是错误，这个就需要进行混合错误和警告规则的配置。

## 开启混合规则

要在 @typescript-eslint/naming-convention 规则中同时使用错误和警告规则，我们可以通过在 ESLint 配置中配置 severity 属性来实现。severity 属性可以用来指定规则的严重程度，支持三个选项："error"、"warn" 和 "off"，分别代表错误、警告和禁用。

## 案例代码

下面我们来看一个具体的案例代码，通过配置混合规则来控制命名约定的严重程度。

typescript
// eslint配置文件.eslintrc.JS
module.exports = {
  // ...
  rules: {
    '@typescript-eslint/naming-convention': [
      'error',
      {
        selector: 'variable',
        format: ['camelCase', 'UPPER_CASE'],
        leadingUnderscore: 'allow',
        trAIlingUnderscore: 'allow',
      },
      {
        selector: 'function',
        format: ['camelCase', 'PascalCase'],
      },
      {
        selector: 'typeLike',
        format: ['PascalCase'],
      },
    ],
  },
};

在上面的代码中，我们配置了 @typescript-eslint/naming-convention 规则，指定了不同类型的命名约定。对于变量名，我们要求使用驼峰命名法或全大写字母，同时允许使用前置或后置下划线；对于函数名，我们要求使用驼峰命名法或帕斯卡命名法；对于类型名，我们要求使用帕斯卡命名法。

## 混合错误和警告规则的配置

为了将某些命名规则配置为警告而不是错误，我们可以在配置中使用 severity 属性。以下是一个例子：

typescript
// eslint配置文件.eslintrc.JS
module.exports = {
  // ...
  rules: {
    '@typescript-eslint/naming-convention': [
      'error',
      {
        selector: 'variable',
        format: ['camelCase', 'UPPER_CASE'],
        leadingUnderscore: 'allow',
        trAIlingUnderscore: 'allow',
      },
      {
        selector: 'function',
        format: ['camelCase', 'PascalCase'],
      },
      {
        selector: 'typeLike',
        format: ['PascalCase'],
        severity: 'warn',
      },
    ],
  },
};

在上面的配置中，我们将 selector 为 'typeLike' 的规则的 severity 属性设置为 'warn'，这样就将该规则配置为警告而不是错误。

注意： 在 ESLint 配置中，如果某个规则被同时配置了错误和警告的 severity，则会以错误为准。

##

通过使用 @typescript-eslint/naming-convention 规则集，并结合 severity 属性的配置，我们可以控制命名约定的严重程度，将某些规则配置为警告而不是错误。这样能够帮助我们遵循一致的命名约定，提高代码的可读性和可维护性。