eslint-plugin-perfectionist 中 sort-exports 规则的进阶用法:类型导出排序优化
2025-06-30 12:14:11作者:彭桢灵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 的团队来说,合理配置导出排序规则可以显著提升代码质量,同时减少团队成员在代码风格上的分歧。
登录后查看全文
热门项目推荐
相关项目推荐
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 StartedRust0214
cann-learning-hubCANN 学习中心仓,支持在线互动运行、边学边练,提供教程、示例与优化方案,一站式助力昇腾开发者快速上手。Jupyter Notebook0138
uni-appA cross-platform framework using Vue.jsJavaScript08
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
469
465
暂无描述
Dockerfile
778
5.08 K
Ascend Extension for PyTorch
Python
758
968
本项目是CANN提供的transformer类大模型算子库,实现网络在NPU上加速计算。
C++
877
2.03 K
本项目是CANN提供的神经网络类计算算子库,实现网络在NPU上加速计算。
C++
697
1.4 K
昇腾LLM分布式训练框架
Python
185
231
JiuwenSwarm 是一款基于openJiuwen开发的智能AI Agent,它能够将大语言模型的强大能力,通过你日常使用的各类通讯应用,直接延伸至你的指尖。
Python
2.25 K
676
本项目是CANN提供的数学类基础计算算子库,实现网络在NPU上加速计算。
C++
1.1 K
1.14 K
本仓库是 Flutter SDK 与 Flutter Engine 的 OpenHarmony 适配版本,由 CPF-Flutter 团队维护。开发者可使用熟悉的 Flutter 技术栈开发 OpenHarmony 应用,3.35.7 及以后的适配版本可基于本仓库源码构建支持 OpenHarmony 的 Flutter Engine。
Dart
1.04 K
271