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 代码风格管理领域的地位,为开发者提供了更完善、更灵活的工具来维护高质量的代码库。
登录后查看全文
热门项目推荐
相关项目推荐
GLM-5智谱 AI 正式发布 GLM-5,旨在应对复杂系统工程和长时域智能体任务。Jinja00
GLM-5-w4a8GLM-5-w4a8基于混合专家架构,专为复杂系统工程与长周期智能体任务设计。支持单/多节点部署,适配Atlas 800T A3,采用w4a8量化技术,结合vLLM推理优化,高效平衡性能与精度,助力智能应用开发Jinja00- QQwen3.5-397B-A17BQwen3.5 实现了重大飞跃,整合了多模态学习、架构效率、强化学习规模以及全球可访问性等方面的突破性进展,旨在为开发者和企业赋予前所未有的能力与效率。Jinja00
Kimi-K2.5Kimi K2.5 是一款开源的原生多模态智能体模型,它在 Kimi-K2-Base 的基础上,通过对约 15 万亿混合视觉和文本 tokens 进行持续预训练构建而成。该模型将视觉与语言理解、高级智能体能力、即时模式与思考模式,以及对话式与智能体范式无缝融合。Python00
MiniMax-M2.5MiniMax-M2.5开源模型,经数十万复杂环境强化训练,在代码生成、工具调用、办公自动化等经济价值任务中表现卓越。SWE-Bench Verified得分80.2%,Multi-SWE-Bench达51.3%,BrowseComp获76.3%。推理速度比M2.1快37%,与Claude Opus 4.6相当,每小时仅需0.3-1美元,成本仅为同类模型1/10-1/20,为智能应用开发提供高效经济选择。【此简介由AI生成】Python00
ruoyi-plus-soybeanRuoYi-Plus-Soybean 是一个现代化的企业级多租户管理系统,它结合了 RuoYi-Vue-Plus 的强大后端功能和 Soybean Admin 的现代化前端特性,为开发者提供了完整的企业管理解决方案。Vue06- RRing-2.5-1TRing-2.5-1T:全球首个基于混合线性注意力架构的开源万亿参数思考模型。Python00
Qwen3.5Qwen3.5 昇腾 vLLM 部署教程。Qwen3.5 是 Qwen 系列最新的旗舰多模态模型,采用 MoE(混合专家)架构,在保持强大模型能力的同时显著降低了推理成本。00
项目优选
收起
deepin linux kernel
C
27
11
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
570
3.84 K
Ascend Extension for PyTorch
Python
381
456
本项目是CANN提供的数学类基础计算算子库,实现网络在NPU上加速计算。
C++
894
679
暂无简介
Dart
803
198
openEuler内核是openEuler操作系统的核心,既是系统性能与稳定性的基石,也是连接处理器、设备与服务的桥梁。
C
353
209
昇腾LLM分布式训练框架
Python
119
146
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
12
1
🔥LeetCode solutions in any programming language | 多种编程语言实现 LeetCode、《剑指 Offer(第 2 版)》、《程序员面试金典(第 6 版)》题解
Java
68
20
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
1.37 K
781