eslint-plugin-perfectionist 中 sort-exports 规则的进阶用法:类型导出排序优化
2025-06-30 17:39:39作者:彭桢灵Jeremy
在 TypeScript 和 React 开发中,模块导出的组织方式对代码可读性和维护性有着重要影响。eslint-plugin-perfectionist 项目的 sort-exports 规则提供了强大的导出排序功能,但在处理类型导出时存在一些值得优化的地方。
当前规则的局限性
默认情况下,sort-exports 规则会将所有导出语句(包括常规导出和类型导出)统一排序。这意味着当开发者希望将类型导出放在文件底部时,规则可能会强制要求将它们移动到其他位置。例如:
// 开发者期望的写法
export { MapMarker };
export { BOUNDS_PADDING } from "./utils";
export type { MapMarkerProps } from "./prop.types";
// 但规则可能要求改为
export type { MapMarkerProps } from "./prop.types";
export { MapMarker };
export { BOUNDS_PADDING } from "./utils";
这种排序方式虽然符合字母顺序,但不符合许多团队对类型导出的组织偏好。
类型导出的最佳实践
在 TypeScript 社区中,将类型导出与非类型导出分离是一种常见的最佳实践,这样做有几个优点:
- 可读性:将实现代码与类型定义分离,使文件结构更清晰
- 维护性:类型变更时更容易定位相关代码
- 构建优化:有助于 tree-shaking,因为类型在编译后会被移除
解决方案:独立排序类型导出
eslint-plugin-perfectionist 的最新版本已经支持通过配置选项来实现类型导出的独立排序。开发者可以配置规则,使类型导出始终保持在其他导出之后,同时各自组内保持有序。
配置示例:
{
"rules": {
"perfectionist/sort-exports": [
"error",
{
"groups": ["type", "non-type"],
"order": "asc"
}
]
}
}
这种配置下,规则会:
- 首先处理所有非类型导出(
export {...}
) - 然后处理所有类型导出(
export type {...}
) - 每个组内按照字母顺序排序
实际应用场景
这种排序方式特别适合以下场景:
- React 组件库:组件实现和props类型分开导出
- 工具函数集合:功能函数和它们的类型定义分开管理
- API 客户端:请求函数和响应类型分开组织
进阶配置选项
除了基本的分组排序,还可以结合其他选项实现更精细的控制:
- 自定义分组顺序:可以调整类型导出和非类型导出的前后顺序
- 混合排序:某些情况下可能需要混合排序,可以通过更复杂的配置实现
- 忽略特定导出:通过注释可以临时禁用某些导出的排序检查
总结
eslint-plugin-perfectionist 的 sort-exports 规则通过支持类型导出的独立排序,为 TypeScript 项目提供了更符合实际开发需求的代码组织方式。这种配置不仅保持了代码的一致性,还尊重了类型与非类型分离的最佳实践,使得代码库更加整洁和易于维护。
对于使用 TypeScript 的团队来说,合理配置导出排序规则可以显著提升代码质量,同时减少团队成员在代码风格上的分歧。
登录后查看全文
热门项目推荐
相关项目推荐
HunyuanImage-3.0
HunyuanImage-3.0 统一多模态理解与生成,基于自回归框架,实现文本生成图像,性能媲美或超越领先闭源模型00- DDeepSeek-V3.2-ExpDeepSeek-V3.2-Exp是DeepSeek推出的实验性模型,基于V3.1-Terminus架构,创新引入DeepSeek Sparse Attention稀疏注意力机制,在保持模型输出质量的同时,大幅提升长文本场景下的训练与推理效率。该模型在MMLU-Pro、GPQA-Diamond等多领域公开基准测试中表现与V3.1-Terminus相当,支持HuggingFace、SGLang、vLLM等多种本地运行方式,开源内核设计便于研究,采用MIT许可证。【此简介由AI生成】Python00
GitCode-文心大模型-智源研究院AI应用开发大赛
GitCode&文心大模型&智源研究院强强联合,发起的AI应用开发大赛;总奖池8W,单人最高可得价值3W奖励。快来参加吧~0361Hunyuan3D-Part
腾讯混元3D-Part00ops-transformer
本项目是CANN提供的transformer类大模型算子库,实现网络在NPU上加速计算。C++087Hunyuan3D-Omni
腾讯混元3D-Omni:3D版ControlNet突破多模态控制,实现高精度3D资产生成00Spark-Chemistry-X1-13B
科大讯飞星火化学-X1-13B (iFLYTEK Spark Chemistry-X1-13B) 是一款专为化学领域优化的大语言模型。它由星火-X1 (Spark-X1) 基础模型微调而来,在化学知识问答、分子性质预测、化学名称转换和科学推理方面展现出强大的能力,同时保持了强大的通用语言理解与生成能力。Python00GOT-OCR-2.0-hf
阶跃星辰StepFun推出的GOT-OCR-2.0-hf是一款强大的多语言OCR开源模型,支持从普通文档到复杂场景的文字识别。它能精准处理表格、图表、数学公式、几何图形甚至乐谱等特殊内容,输出结果可通过第三方工具渲染成多种格式。模型支持1024×1024高分辨率输入,具备多页批量处理、动态分块识别和交互式区域选择等创新功能,用户可通过坐标或颜色指定识别区域。基于Apache 2.0协议开源,提供Hugging Face演示和完整代码,适用于学术研究到工业应用的广泛场景,为OCR领域带来突破性解决方案。00- HHowToCook程序员在家做饭方法指南。Programmer's guide about how to cook at home (Chinese only).Dockerfile09
- PpathwayPathway is an open framework for high-throughput and low-latency real-time data processing.Python00
项目优选
收起

deepin linux kernel
C
22
6

OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
191
2.15 K

React Native鸿蒙化仓库
C++
205
284

Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
9
1

Ascend Extension for PyTorch
Python
58
89

🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
968
572

本项目是CANN提供的数学类基础计算算子库,实现网络在NPU上加速计算。
C++
547
76

openGauss kernel ~ openGauss is an open source relational database management system
C++
146
192

旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
1.02 K
399

本项目是CANN开源社区的核心管理仓库,包含社区的治理章程、治理组织、通用操作指引及流程规范等基础信息
392
23