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 StartedRust0218
cann-learning-hubCANN 学习中心仓,支持在线互动运行、边学边练,提供教程、示例与优化方案,一站式助力昇腾开发者快速上手。Jupyter Notebook0139
uni-appA cross-platform framework using Vue.jsJavaScript09
GLM-5.2智谱开源 GLM-5.2,这是针对长文本任务的最新旗舰模型。相较于前代产品 GLM-5.1,它在长文本任务处理能力上实现了显著飞跃,并且首次在稳定的 100 万 token 上下文中提供这一能力。Jinja00
SwanLab⚡️SwanLab - an open-source, modern-design AI training tracking and visualization tool. Supports Cloud / Self-hosted use. Integrated with PyTorch / Transformers / LLaMA Factory / veRL/ Swift / Ultralytics / MMEngine / Keras etc.Python00
tiny-universe《大模型白盒子构建指南》:一个全手搓的Tiny-UniverseJupyter Notebook03
项目优选
收起
deepin linux kernel
C
32
16
openEuler内核是openEuler操作系统的核心,既是系统性能与稳定性的基石,也是连接处理器、设备与服务的桥梁。
C
471
465
Ascend Extension for PyTorch
Python
758
968
昇腾LLM分布式训练框架
Python
186
231
本项目是CANN提供的神经网络类计算算子库,实现网络在NPU上加速计算。
C++
699
1.4 K
本项目是CANN提供的transformer类大模型算子库,实现网络在NPU上加速计算。
C++
879
2.03 K
暂无描述
Dockerfile
780
5.08 K
🔥LeetCode solutions in any programming language | 多种编程语言实现 LeetCode、《剑指 Offer(第 2 版)》、《程序员面试金典(第 6 版)》题解
Java
70
22
本仓库是 Flutter SDK 与 Flutter Engine 的 OpenHarmony 适配版本,由 CPF-Flutter 团队维护。开发者可使用熟悉的 Flutter 技术栈开发 OpenHarmony 应用,3.35.7 及以后的适配版本可基于本仓库源码构建支持 OpenHarmony 的 Flutter Engine。
Dart
1.04 K
271
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
2.09 K
217