首页
/ 在ESLint配置中正确使用Prettier插件

在ESLint配置中正确使用Prettier插件

2025-06-24 03:14:16作者:郁楠烈Hubert

在JavaScript和TypeScript项目中,ESLint和Prettier是开发者常用的代码质量工具。它们分别负责代码规范检查和代码格式化。当两者一起使用时,需要特别注意配置方式,以避免规则冲突和冗余配置。

配置冗余问题分析

在ESLint的配置文件中,开发者经常会看到两种与Prettier相关的配置项:

  1. 'prettier' - 来自eslint-config-prettier
  2. 'plugin:prettier/recommended' - 来自eslint-plugin-prettier

实际上,plugin:prettier/recommended已经包含了eslint-config-prettier的功能,它会自动关闭所有可能与Prettier冲突的ESLint规则。因此,单独添加'prettier'是多余的,可以安全地移除。

现代ESLint配置的最佳实践

对于使用ESLint新配置格式(Flat Config)的项目,推荐直接导入Prettier插件的推荐配置:

import prettierRecommended from 'eslint-plugin-prettier/recommended';

这种方式更加简洁明了,避免了传统配置方式中可能出现的冗余问题。

工作原理解析

eslint-plugin-prettier的工作原理是:

  1. 将Prettier作为ESLint规则运行
  2. 自动应用Prettier的格式化规则
  3. 通过内置的eslint-config-prettier禁用所有可能冲突的ESLint规则

这种设计使得开发者无需额外配置就能获得完整的Prettier集成体验。

实际项目配置建议

对于现代JavaScript/TypeScript项目,特别是使用React或Next.js的项目,推荐的ESLint配置应该:

  1. 只包含plugin:prettier/recommended
  2. 移除单独的prettier配置项
  3. 确保Prettier本身的配置文件(.prettierrc)存在并配置正确

这样可以保持配置简洁,同时确保代码格式化的一致性和规范性。

登录后查看全文
热门项目推荐

项目优选

收起
docsdocs
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
139
1.91 K
kernelkernel
deepin linux kernel
C
22
6
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
8
0
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
192
273
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
923
551
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
421
392
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
145
189
金融AI编程实战金融AI编程实战
为非计算机科班出身 (例如财经类高校金融学院) 同学量身定制,新手友好,让学生以亲身实践开源开发的方式,学会使用计算机自动化自己的科研/创新工作。案例以量化投资为主线,涉及 Bash、Python、SQL、BI、AI 等全技术栈,培养面向未来的数智化人才 (如数据工程师、数据分析师、数据科学家、数据决策者、量化投资人)。
Jupyter Notebook
74
64
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
344
1.3 K
easy-eseasy-es
Elasticsearch 国内Top1 elasticsearch搜索引擎框架es ORM框架,索引全自动智能托管,如丝般顺滑,与Mybatis-plus一致的API,屏蔽语言差异,开发者只需要会MySQL语法即可完成对Es的相关操作,零额外学习成本.底层采用RestHighLevelClient,兼具低码,易用,易拓展等特性,支持es独有的高亮,权重,分词,Geo,嵌套,父子类型等功能...
Java
36
8