【亲测免费】 ESLint 插件 `eslint-plugin-import` 技术文档

本篇文档旨在详细介绍如何使用并深入了解 eslint-plugin-import 这一插件，它专为支持ES2015+(亦称为ES6+)中的导入/导出语法检查而设计，防止文件路径拼写错误和导入名错误。通过此插件，您可以获得ES模块静态语法所承诺的所有优势，并在编辑器中得到明确的标记。

安装指南

要使用 eslint-plugin-import，您首先需要确保您的项目中已经安装了ESLint。如果没有，可以通过以下命令全局或局部安装ESLint：

npm install --save-dev eslint

之后，安装 eslint-plugin-import：

npm install --save-dev eslint-plugin-import

或者如果您使用的是Yarn：

yarn add --dev eslint-plugin-import

项目的使用说明

一旦安装完成，您需要在ESLint配置文件中（通常是.eslintrc.js或.eslintrc.yml）激活该插件。示例如下（以.eslintrc.js为例）：

module.exports = {
    "plugins": [
        "import"
    ],
    "rules": {
        // 开启一些推荐的规则
        "import/no-unresolved": "error",
        "import/extensions": ["error", "always", {
            "js": "never",
            "jsx": "never",
            "ts": "never",
            "tsx": "never"
        }],
        // 根据需要启用更多的规则...
    },
};

项目API使用文档

规则概览

eslint-plugin-import 提供了许多规则来指导正确的导入/导出实践。下面是一些关键规则的简要介绍：

• no-unresolved: 确保所有导入都能指向可解析的文件或模块。
• import/extensions: 控制导入时是否需要指定文件扩展名。
• import/no-extraneous-dependencies: 避免使用非依赖项包。
• import/named: 确保命名导入匹配远程文件的导出。
• import/default: 当有默认导入时，确保有一个对应的默认导出。
• import/newline-after-import: 导入语句后要求新行。

详细的规则文档可以在插件的每个规则页面找到，通常位于其GitHub仓库的docs/rules/目录下，如docs/rules/no-unresolved.md。

项目安装方式

前面已详细介绍了项目的安装步骤，概括如下：

1. 确保项目中有ESLint。
2. 使用npm或Yarn安装eslint-plugin-import到开发依赖。
3. 更新ESLint配置文件以启用和调整插件规则。

Sublime Text 用户须知

对于Sublime Text用户，文档底部提供了重要信息，确保eslint-plugin-import能在编辑器内正确工作，请参照文档相应部分进行设置。

通过遵循以上指南，您将能够充分利用 eslint-plugin-import 来提升代码质量，避免常见的导入导出相关错误，保持代码风格一致，以及利用自动化工具提高开发效率。