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 的团队来说,合理配置导出排序规则可以显著提升代码质量,同时减少团队成员在代码风格上的分歧。
登录后查看全文
热门项目推荐
相关项目推荐
PaddleOCR-VLPaddleOCR-VL 是一款顶尖且资源高效的文档解析专用模型。其核心组件为 PaddleOCR-VL-0.9B,这是一款精简却功能强大的视觉语言模型(VLM)。该模型融合了 NaViT 风格的动态分辨率视觉编码器与 ERNIE-4.5-0.3B 语言模型,可实现精准的元素识别。Python00- DDeepSeek-OCRDeepSeek-OCR是一款以大语言模型为核心的开源工具,从LLM视角出发,探索视觉文本压缩的极限。Python00
MiniCPM-V-4_5MiniCPM-V 4.5 是 MiniCPM-V 系列中最新且功能最强的模型。该模型基于 Qwen3-8B 和 SigLIP2-400M 构建,总参数量为 80 亿。与之前的 MiniCPM-V 和 MiniCPM-o 模型相比,它在性能上有显著提升,并引入了新的实用功能Python00
HunyuanWorld-Mirror混元3D世界重建模型,支持多模态先验注入和多任务统一输出Python00
AI内容魔方AI内容专区,汇集全球AI开源项目,集结模块、可组合的内容,致力于分享、交流。03
Spark-Scilit-X1-13B科大讯飞Spark Scilit-X1-13B基于最新一代科大讯飞基础模型,并针对源自科学文献的多项核心任务进行了训练。作为一款专为学术研究场景打造的大型语言模型,它在论文辅助阅读、学术翻译、英语润色和评论生成等方面均表现出色,旨在为研究人员、教师和学生提供高效、精准的智能辅助。Python00
GOT-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).Dockerfile014
Spark-Chemistry-X1-13B科大讯飞星火化学-X1-13B (iFLYTEK Spark Chemistry-X1-13B) 是一款专为化学领域优化的大语言模型。它由星火-X1 (Spark-X1) 基础模型微调而来,在化学知识问答、分子性质预测、化学名称转换和科学推理方面展现出强大的能力,同时保持了强大的通用语言理解与生成能力。Python00- PpathwayPathway is an open framework for high-throughput and low-latency real-time data processing.Python00
最新内容推荐
Windows版Redis 5.0.14下载资源:高效内存数据库的完美Windows解决方案 PCDViewer-4.9.0-Ubuntu20.04:专业点云可视化与编辑工具全面解析 基于Matlab的等几何分析IGA软件包:工程计算与几何建模的完美融合 谷歌浏览器跨域插件Allow-Control-Allow-Origin:前端开发调试必备神器 Adobe Acrobat XI Pro PDF拼版插件:提升排版效率的专业利器 PADS元器件位号居中脚本:提升PCB设计效率的自动化利器 PANTONE潘通AI色板库:设计师必备的色彩管理利器 海能达HP680CPS-V2.0.01.004chs写频软件:专业对讲机配置管理利器 MQTT 3.1.1协议中文版文档:物联网开发者的必备技术指南 RadiAnt DICOM Viewer 2021.2:专业医学影像阅片软件的全面指南
项目优选
收起
deepin linux kernel
C
24
6
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
269
2.54 K
暂无简介
Dart
558
124
一个用于服务器应用开发的综合工具库。
- 零配置文件
- 环境变量和命令行参数配置
- 约定优于配置
- 深刻利用仓颉语言特性
- 只需要开发动态链接库,fboot负责加载、初始化并运行。
Cangjie
57
11
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
9
1
仓颉编程语言运行时与标准库。
Cangjie
126
104
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
357
1.84 K
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
1.02 K
434
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
1.03 K
605
🍒 Cherry Studio 是一款支持多个 LLM 提供商的桌面客户端
TypeScript
728
70