eslint-plugin-perfectionist 新增对象类型排序可选性顺序功能
2025-06-30 17:23:07作者:尤辰城Agatha
在 TypeScript 开发中,保持代码风格一致性对于团队协作和代码可维护性至关重要。eslint-plugin-perfectionist 作为一款专注于代码风格规范的 ESLint 插件,近期在其 sort-object-types 规则中新增了一个重要功能:optionality-order 选项。
功能背景
TypeScript 中的对象类型(包括 interface 和 type)可以包含可选属性(使用 ? 标记)和必需属性。在大型项目中,统一这些属性的排列顺序能够显著提升代码的可读性。此前,sort-interfaces 规则已经支持通过 optionality-order 选项来分组排列必需和可选属性,现在这一功能扩展到了 type 类型的排序中。
功能详解
新功能允许开发者为对象类型定义属性排序策略,具体表现为:
- 可以配置
optionality-order为required-first,将必需属性排在可选属性之前 - 支持与自然排序(natural-case-insensitive)结合使用
- 同时适用于 interface 和 type 类型的排序
实际应用
这一更新使得开发者能够通过配置实现与 @typescript-eslint/member-ordering 类似的效果,但提供了更简洁的配置方式和自动修复功能。例如:
// 配置示例
{
"rules": {
"perfectionist/sort-object-types": [
"error",
{
"type": "natural-case-insensitive",
"optionality-order": "required-first"
}
]
}
}
应用此配置后,代码会自动调整为:
// 自动修复前
type User = {
age?: number;
name: string;
email?: string;
id: string;
};
// 自动修复后
type User = {
id: string;
name: string;
age?: number;
email?: string;
};
技术价值
这一功能的加入带来了几个显著优势:
- 一致性增强:统一了 interface 和 type 的排序规则,减少了团队内部的风格分歧
- 可维护性提升:通过将必需属性前置,开发者能更快识别类型的关键部分
- 迁移便利:为从
@typescript-eslint/member-ordering迁移提供了更轻量级的替代方案 - 自动化支持:内置的自动修复功能减少了手动调整的工作量
最佳实践建议
对于团队项目,建议:
- 在项目初期就配置好排序规则,避免后期大规模重构
- 将必需属性前置(required-first)作为默认选项,这符合大多数开发者的阅读习惯
- 结合其他排序规则(如字母顺序)使用,形成完整的代码风格规范
- 在 CI/CD 流程中加入相关检查,确保代码风格一致性
eslint-plugin-perfectionist 的这一更新进一步巩固了其在 TypeScript 代码风格管理领域的地位,为开发者提供了更完善、更灵活的工具来维护高质量的代码库。
登录后查看全文
热门项目推荐
相关项目推荐
Kimi-K2.5Kimi K2.5 是一款开源的原生多模态智能体模型,它在 Kimi-K2-Base 的基础上,通过对约 15 万亿混合视觉和文本 tokens 进行持续预训练构建而成。该模型将视觉与语言理解、高级智能体能力、即时模式与思考模式,以及对话式与智能体范式无缝融合。Python00
GLM-4.7-FlashGLM-4.7-Flash 是一款 30B-A3B MoE 模型。作为 30B 级别中的佼佼者,GLM-4.7-Flash 为追求性能与效率平衡的轻量化部署提供了全新选择。Jinja00
VLOOKVLOOK™ 是优雅好用的 Typora/Markdown 主题包和增强插件。 VLOOK™ is an elegant and practical THEME PACKAGE × ENHANCEMENT PLUGIN for Typora/Markdown.Less00
PaddleOCR-VL-1.5PaddleOCR-VL-1.5 是 PaddleOCR-VL 的新一代进阶模型,在 OmniDocBench v1.5 上实现了 94.5% 的全新 state-of-the-art 准确率。 为了严格评估模型在真实物理畸变下的鲁棒性——包括扫描伪影、倾斜、扭曲、屏幕拍摄和光照变化——我们提出了 Real5-OmniDocBench 基准测试集。实验结果表明,该增强模型在新构建的基准测试集上达到了 SOTA 性能。此外,我们通过整合印章识别和文本检测识别(text spotting)任务扩展了模型的能力,同时保持 0.9B 的超紧凑 VLM 规模,具备高效率特性。Python00
KuiklyUI基于KMP技术的高性能、全平台开发框架,具备统一代码库、极致易用性和动态灵活性。 Provide a high-performance, full-platform development framework with unified codebase, ultimate ease of use, and dynamic flexibility. 注意:本仓库为Github仓库镜像,PR或Issue请移步至Github发起,感谢支持!Kotlin07
compass-metrics-modelMetrics model project for the OSS CompassPython00
项目优选
收起
deepin linux kernel
C
27
11
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
523
3.71 K
Ascend Extension for PyTorch
Python
328
384
本项目是CANN提供的数学类基础计算算子库,实现网络在NPU上加速计算。
C++
876
577
openEuler内核是openEuler操作系统的核心,既是系统性能与稳定性的基石,也是连接处理器、设备与服务的桥梁。
C
335
161
暂无简介
Dart
762
187
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
1.33 K
745
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
12
1
React Native鸿蒙化仓库
JavaScript
302
349
华为昇腾面向大规模分布式训练的多模态大模型套件,支撑多模态生成、多模态理解。
Python
112
135