ESLint 配置迁移

概览

此软件包辅助了遗留的 ESLint 配置文件格式的迁移(.eslintrc.)到新的ESLint配置文件格式(eslint.config.js) (中文(简体) ).

说明: 生成的配置文件并不保证在所有情况下都能工作,但它应该比手动试图迁移更接近工作配置文件.

限制

此工具目前对以下配置文件格式很有效 :

• .eslintrc
• .eslintrc.json
• .eslintrc.yml

如果您正在使用 JavaScript 配置文件(.eslintrc.js, (中文(简体) ), .eslintrc.cjs, (中文(简体) ), .eslintrc.mjs该工具目前只能迁移 评价 配置 。 这意味着你可能掌握的文件里的任何逻辑都会丢失. 如果您的配置文件大多是静态的,那么会得到一个好的结果;如果您的配置文件比较复杂(使用函数,计算路径等),那么这个工具不会提供等同的配置文件.

使用量

您可以在命令行上运行此软件包, 而无需先使用 npx 或类似工具:

npx @eslint/migrate-config .eslintrc.json
# or
bunx @eslint/migrate-config .eslintrc.json

工具会自动找到您的 .eslintignore 中的文件并移动到您的新配置文件中.

如果您在运行时收到 npm 错误 npx,首先手动安装软件包:

npm i @eslint/migrate-config
npx @eslint/migrate-config .eslintrc.json

常见JS 输出

默认情况下,此工具生成一个ESM文件(.mjs 扩展)。 如果您想生成一个普通JS文件, 请通过 --commonjs 旗帜 :

npx @eslint/migrate-config .eslintrc.json --commonjs
# or
bunx @eslint/migrate-config .eslintrc.json --commonjs

包括a .gitignore 文件

如果您正在使用 --ignore-path .gitignore 在CLI上,你需要阅读 .gitignore 文件输入您的配置文件。 迁移可以帮你处理这个 通过传递 --gitignore 旗帜 :

npx @eslint/migrate-config .eslintrc.json --gitignore
# or
bunx @eslint/migrate-config .eslintrc.json --gitignore

针对特定ESLint版本

默认情况下,这个工具针对的是最新的ESLint可用版本(v10). 您可以通过通过 --target-version 选项 :

npx @eslint/migrate-config .eslintrc.json --target-version 9
# or
bunx @eslint/migrate-config .eslintrc.json --target-version 9

后续步骤

完成迁移后,可能需要手动修改产生的配置文件.

升级插件和双检查兼容性

对于配置文件中使用的任何插件,请确保升级到最新版本。 许多插件正在创建它们的 v9 兼容版本,而这个工具可能已经过时,与之相关的插件完全支持 v9.

升级后, 重复检查插件是否还需要任何作为迁移的一部分而自动生成的兼容工具 .

--ext

使用时 --ext 在命令行上,例如:

npx eslint --ext .ts .

你需要去除这个 --ext 从命令行中添加一个等效对象到您的配置文件。 譬如说, --ext .ts 在配置文件中需要这样的对象 :

export default [
    {
        files: ["**/*.ts"],
    },

    // the rest of your config
];

它告诉 ESLint 要搜索结束于 .ts 当命令行上传递目录时。 如果您愿意, 您可以选择在此对象上添加额外的属性, 但不需要 .

许可证

Apache 2.0 (英语)

发起人

以下公司,组织,个人支持ESLint的持续维护与发展. 成为发起人 让你的标志在我们的读取器和 网站。 。 。 .

黄金赞助商

白银赞助商

青铜赞助商

技术赞助商