如何解决eslint 和 prettier 格式化代码冲突

当 ESLint 和 Prettier 在格式化代码上出现冲突时,通常是因为它们对代码风格的某些规则有不同的要求,导致代码格式化的结果不一致。解决这类冲突可以通过以下几种方法:

# 配置 ESLint 和 Prettier 共存

使用 eslint-config-prettier:这是一种常见的解决方法,它可以确保 ESLint 中与 Prettier 冲突的规则被禁用,避免格式化时的冲突。

npm install --save-dev eslint-config-prettier
1

在你的 ESLint 配置文件(如 .eslintrc.json 或 .eslintrc.js)中,扩展这个配置:

{
"extends": [
"eslint:recommended",
"plugin:your-preferred-eslint-plugin/recommended",
"prettier"
]
}
1
2
3
4
5
6
7

这样做会确保 ESLint 在检查代码质量时,不会与 Prettier 的格式化规则发生冲突。

# 使用 eslint-plugin-prettier

这个插件可以将 Prettier 的格式化功能整合到 ESLint 中,并在 ESLint 中检查与 Prettier 冲突的规则。

npm install --save-dev eslint-plugin-prettier
1

在 ESLint 配置文件中配置插件:

{
"plugins": ["prettier"],
"rules": {
"prettier/prettier": "error"
}
}
1
2
3
4
5
6

这样配置后,ESLint 将会在检查代码时同时运行 Prettier 的格式化,并标记与 Prettier 冲突的规则为错误。