ESLint 配置：仅启用插件中的特定规则

在现代javascript项目中，eslint已成为代码质量和风格统一不可或缺的工具。通过各种插件，eslint能够检查特定框架、库或特定代码模式的问题。然而，有时我们可能只希望从一个eslint插件中启用某一条或几条特定规则，而不是接受其所有预设的推荐规则集。例如，您可能只想使用eslint-plugin-import插件中的import/named规则，而不想启用import/no-unresolved或其他与导入相关的规则。

理解 ESLint 配置中的 extends 与 plugins

要实现对插件规则的精细化控制，首先需要理解ESLint配置文件中extends和plugins这两个核心属性的作用：

• plugins: 这个数组用于声明ESLint配置中将使用的插件。它告诉ESLint存在哪些插件，并使其提供的规则可以在rules部分被引用。重要的是，plugins本身并不会启用任何规则，它仅仅是注册了这些规则。
• extends: 这个数组用于扩展或继承其他配置。它可以是一个字符串（如eslint:recommended），也可以是插件提供的预设配置（如plugin:import/errors）。当您使用extends引入一个插件的预设配置时，例如plugin:import/errors，它会一次性启用该插件中被认为是“错误”的一系列规则，而无需您逐条手动配置。

问题的症结通常在于，当用户只想使用插件中的一条规则时，却错误地使用了extends来引入整个预设规则集，导致许多不必要的规则被启用。

实现仅启用特定规则的最小化配置

假设我们希望仅启用eslint-plugin-import插件中的import/named规则，而不引入plugin:import/errors中包含的其他规则（如import/no-unresolved）。

常见的过度配置示例：

许多用户可能会尝试以下配置，认为这样可以启用import/named并禁用其他规则：

{
  "extends": ["plugin:import/errors"],
  "plugins": ["import"],
  "rules": {
    "import/named": 2
    // 还需要手动添加 'import/no-unresolved': 0 等来禁用其他规则，非常繁琐
  }
}

在这种配置中，extends: ["plugin:import/errors"]会引入eslint-plugin-import插件中所有被标记为错误的规则。即使您在rules中明确设置了import/named: 2，其他由plugin:import/errors引入的规则（如import/no-unresolved）仍然会生效，除非您逐一将它们设置为0来禁用，这显然不是一个高效或简洁的解决方案。

标贝悦读AI配音

在线文字转语音软件-专业的配音网站

20

查看详情

推荐的最小化配置：

要实现仅启用特定规则的目标，最简洁和直接的方法是完全移除extends中对插件预设规则集的引用。

{
  "plugins": ["import"],
  "rules": {
    "import/named": 2
  }
}

配置解析：

1. "plugins": ["import"]: 这一行告诉ESLint，我们将使用eslint-plugin-import插件。这使得该插件提供的所有规则（包括import/named）都可以在rules部分被识别和配置。
2. "rules": { "import/named": 2 }: 这一行是核心。它明确地启用了eslint-plugin-import插件中的import/named规则，并将其严重级别设置为2（表示错误）。

通过这种方式，ESLint将不会自动启用eslint-plugin-import插件中的任何其他规则，因为我们没有通过extends属性引入任何预设规则集。您只启用了您明确指定的import/named规则，实现了真正的精细化控制。

核心原理与优势

• 精简配置：您的.eslintrc文件将只包含您真正需要的规则，避免了不必要的配置项。
• 避免冲突：减少了与其他ESLint配置或自定义规则集发生潜在冲突的可能性。
• 性能优化：ESLint在运行时无需评估和执行那些您不关心的规则，这可能对大型项目的linting速度产生积极影响。
• 高度定制：完全掌控哪些规则处于活动状态，使您的ESLint配置与项目需求完美匹配。

注意事项

• 适用场景：此方法最适用于您确实只需要插件中的极少数规则，并且不希望继承插件的任何默认推荐配置。
• 与extends的结合使用：如果您希望使用插件的大部分推荐规则，但要禁用其中少数几个，那么使用extends引入插件的预设配置（如plugin:import/recommended），然后在rules中将特定规则设置为0（禁用）仍然是更高效的方法。例如：

  {
    "extends": ["plugin:import/recommended"],
    "plugins": ["import"],
    "rules": {
      "import/no-unresolved": 0 // 禁用插件推荐配置中的某条规则
    }
  }

  登录后复制
• 通用性：本文介绍的方法不仅适用于eslint-plugin-import，也适用于任何其他ESLint插件。只要您只想使用插件中的特定规则，就可以采用这种“只注册插件，不扩展其预设配置，然后手动启用所需规则”的策略。

总结

在ESLint配置中，实现对插件规则的精细化控制的关键在于理解extends和plugins的区别。当您只需要插件中的特定规则时，应避免使用extends来引入插件的预设规则集。只需将插件添加到plugins数组以注册它，然后直接在rules部分明确指定并配置您需要的规则。这种方法能够帮助您构建一个更简洁、更高效且高度定制化的ESLint配置。

以上就是ESLint 配置：仅启用插件中的特定规则的详细内容，更多请关注php中文网其它相关文章！