首页
/ eslint-plugin-perfectionist 新增类型分组排序功能解析

eslint-plugin-perfectionist 新增类型分组排序功能解析

2025-06-30 17:09:32作者:裘旻烁

eslint-plugin-perfectionist 作为一款专注于代码风格一致性的 ESLint 插件,在最新发布的 3.0.0 版本中新增了对 TypeScript 类型联合和交叉类型的分组排序功能。这一改进源自社区对原 typescript-eslint 中 sort-type-constituents 规则的讨论和需求迁移。

功能背景

在 TypeScript 开发中,类型联合和交叉类型的排序一致性是代码风格的重要组成部分。原 typescript-eslint 中的 sort-type-constituents 规则提供了 groupOrder 选项,允许开发者按照特定分组顺序排列类型成员。随着该规则即将被废弃,社区希望将这一功能迁移到更活跃维护的 eslint-plugin-perfectionist 项目中。

功能详解

新实现的分组排序功能主要作用于两类 TypeScript 类型:

  1. 联合类型:使用 | 连接的类型
  2. 交叉类型:使用 & 连接的类型

分组排序的核心在于将不同类型的成员归类到预定义的组别中,然后按照配置的顺序排列这些组别。例如,开发者可以配置让字面量类型优先于 nullish 类型。

典型使用场景

考虑以下 TypeScript 代码示例:

// 未启用分组排序
type Example = null | 123 | string;

// 启用分组排序(配置为字面量优先)
type Example = 123 | string | null;

通过分组排序,开发者可以确保项目中类型成员的排列遵循统一的逻辑顺序,而不仅仅是字母顺序或自然顺序。这对于提高代码可读性和维护性特别有价值,尤其是在处理复杂类型定义时。

技术实现要点

  1. 分组策略:系统内置了常见类型的分组策略,如字面量类型、nullish 类型等
  2. 自定义配置:开发者可以通过配置项调整分组顺序,满足不同项目的风格要求
  3. 向后兼容:新功能与原有的字母/自然排序方式并存,不影响现有配置

升级建议

对于从 typescript-eslint 迁移过来的项目,建议:

  1. 检查现有项目中是否使用了 groupOrder 配置
  2. 升级到 eslint-plugin-perfectionist 3.0.0 或更高版本
  3. 根据项目需求调整分组排序配置
  4. 逐步替换原有的 sort-type-constituents 规则

这一功能的加入使得 eslint-plugin-perfectionist 在 TypeScript 代码风格检查方面更加完善,为开发者提供了更全面的代码一致性保障方案。

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

项目优选

收起
docsdocs
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
143
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
927
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
75
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