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 代码风格管理领域的地位,为开发者提供了更完善、更灵活的工具来维护高质量的代码库。
登录后查看全文
热门项目推荐
相关项目推荐
atomcodeClaude Code 的开源替代方案。连接任意大模型,编辑代码,运行命令,自动验证 — 全自动执行。用 Rust 构建,极致性能。 | An open-source alternative to Claude Code. Connect any LLM, edit code, run commands, and verify changes — autonomously. Built in Rust for speed. Get StartedRust0148- DDeepSeek-V4-ProDeepSeek-V4-Pro(总参数 1.6 万亿,激活 49B)面向复杂推理和高级编程任务,在代码竞赛、数学推理、Agent 工作流等场景表现优异,性能接近国际前沿闭源模型。Python00
GLM-5.1GLM-5.1是智谱迄今最智能的旗舰模型,也是目前全球最强的开源模型。GLM-5.1大大提高了代码能力,在完成长程任务方面提升尤为显著。和此前分钟级交互的模型不同,它能够在一次任务中独立、持续工作超过8小时,期间自主规划、执行、自我进化,最终交付完整的工程级成果。Jinja00
auto-devAutoDev 是一个 AI 驱动的辅助编程插件。AutoDev 支持一键生成测试、代码、提交信息等,还能够与您的需求管理系统(例如Jira、Trello、Github Issue 等)直接对接。 在IDE 中,您只需简单点击,AutoDev 会根据您的需求自动为您生成代码。Kotlin03
Intern-S2-PreviewIntern-S2-Preview,这是一款高效的350亿参数科学多模态基础模型。除了常规的参数与数据规模扩展外,Intern-S2-Preview探索了任务扩展:通过提升科学任务的难度、多样性与覆盖范围,进一步释放模型能力。Python00
skillhubopenJiuwen 生态的 Skill 托管与分发开源方案,支持自建与可选 ClawHub 兼容。Python0111
热门内容推荐
最新内容推荐
项目优选
收起
暂无描述
Dockerfile
731
4.73 K
Ascend Extension for PyTorch
Python
609
786
本项目是CANN提供的数学类基础计算算子库,实现网络在NPU上加速计算。
C++
1 K
1.01 K
openEuler内核是openEuler操作系统的核心,既是系统性能与稳定性的基石,也是连接处理器、设备与服务的桥梁。
C
433
392
华为昇腾面向大规模分布式训练的多模态大模型套件,支撑多模态生成、多模态理解。
Python
145
237
Claude Code 的开源替代方案。连接任意大模型,编辑代码,运行命令,自动验证 — 全自动执行。用 Rust 构建,极致性能。 | An open-source alternative to Claude Code. Connect any LLM, edit code, run commands, and verify changes — autonomously. Built in Rust for speed.
Get Started
Rust
1.15 K
148
暂无简介
Dart
983
250
Oohos_react_native
React Native鸿蒙化仓库
C++
347
401
昇腾LLM分布式训练框架
Python
166
197
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
1.67 K
985