`eslint-plugin-import-x` 使用教程

eslint-plugin-import-x 使用教程

eslint-plugin-import-x A fork of `eslint-plugin-import` using `get-tsconfig` to replace `tsconfig-paths` and heavy `typescript` under the hood. 项目地址: https://gitcode.com/gh_mirrors/es/eslint-plugin-import-x

项目目录结构及介绍

eslint-plugin-import-x 是一个旨在提供比原始 eslint-plugin-import 更高性能且更轻量级版本的插件。以下是该仓库的基本目录结构及其简介：

• docs: 包含规则说明文档，如 default.md 解释了默认导出相关的规则。
• src: 源代码存放目录，包含了所有插件的核心逻辑实现。
• test: 测试案例目录，确保插件功能按预期工作的测试文件。
• .editorconfig, .prettierrc: 代码风格配置文件，用于保证代码格式的一致性。
• eslintignore: 忽略某些文件或目录不被 ESLint 检查的配置文件。
• gitignore: 控制哪些文件或目录不应被 Git 版本控制的文件。
• LICENSE: 许可证文件，表明该项目遵循 MIT 许可协议。
• package.json: 项目元数据文件，包括依赖项、脚本命令等。
• README.md: 项目的主要读我文件，提供了快速入门和基本说明。
• yarn.lock: Yarn 包管理器锁定文件，确保团队成员拥有相同版本的依赖。

项目的启动文件介绍

此项目本身作为一个 ESLint 插件，并没有直接的“启动”文件让你运行，它是在 ESLint 执行时通过配置文件(.eslintrc.*) 引入并激活的。当你在自己的项目中安装并配置了 eslint-plugin-import-x 后，通过执行 ESLint 命令（通常是在开发流程中的脚本，比如 npm run lint 或者 yarn lint）来间接“启动”这一插件的功能。

项目的配置文件介绍

.eslintrc 配置

由于所有的规则都是默认关闭的，你需要手动在你的 ESLint 配置文件中启用它们。这个配置文件可以是.eslintrc.json, .eslintrc.yml, .eslintrc.js 等多种格式之一。

示例配置（旧系统）:

{
  "plugins": [
    "import-x"
  ],
  "extends": [
    "eslint:recommended",
    "plugin:import-x/recommended"
  ],
  "rules": {
    // 自定义你想要开启或调整的规则
    "import-x/no-unresolved": ["error"]
  }
}

新配置系统 (eslint.config.js):

自 ESLint v8.21.0 起推荐使用新的配置方式，示例如下：

module.exports = [
  require('@eslint/js').configs.recommended,
  require('eslint-plugin-import-x').flatConfigs.recommended
];

如果你的项目使用 TypeScript，还需要额外配置解析器和支持：

module.exports = [
  require('@eslint/js').configs.recommended,
  require('eslint-plugin-import-x').flatConfigs.typescript,
  {
    files: ['**/*.{js,mjs,cjs,jsx,mjsx,ts,tsx,mtsx}'],
    ignores: ['eslint.config.js']
  }
];

记得根据需要调整规则，以满足项目特定的编码标准。配置文件的作用是定制化 ESLint 的行为，以便它能够正确地识别和检查你的 ES2015+ 进口和出口语法，防止导入路径错误等问题。

eslint-plugin-import-x A fork of `eslint-plugin-import` using `get-tsconfig` to replace `tsconfig-paths` and heavy `typescript` under the hood. 项目地址: https://gitcode.com/gh_mirrors/es/eslint-plugin-import-x