typescript
LobeHub 的 TypeScript 开发标准,涵盖类型安全、异步模式、导入规范、UI 组件集成以及性能优化准则。
简介
此技能作为 LobeHub 生态系统中开发人员的综合技术指南。它强制执行严格的 TypeScript 实践,以确保仓库中的代码可维护性、类型安全和架构一致性。专为旨在编写高质量、可扩展代码并与现有模式无缝集成的软件工程师和贡献者而设计。
-
TypeScript 类型安全:关于最小化使用 'any'、利用 'Record<PropertyKey, unknown>'、优先使用 interface 而非 type 来定义对象形状,以及利用 'as const satisfies' 进行更严格约束的准则。
-
架构模式:关于优先使用 ES 模块扩展而非 namespace,以及为了插件扩展性而使用本地化接口合并的说明。
-
异步与并发:使用 async/await、基于 Promise 的 API 以及 Promise.all/race 等并发辅助工具来管理复杂操作的标准。
-
导入标准化:针对 simple-import-sort、consistent-type-imports 的严格规则,以及维护独立类型和值导入语句的要求。
-
UI 与性能:整合 @lobehub/ui 和 antd-style 的要求,以及专注于性能的循环实践和数据库查询优化。
-
使用说明:在启动新模块或对 .ts、.tsx 或 .mts 文件进行重大重构时,请务必参考本指南。
-
实用提示:使用 @ts-expect-error 而非 ts-ignore,优先使用解构赋值以获得更简洁的代码,并在处理逻辑的相邻位置定义元数据字段。
-
约束:避免记录私有用户信息,并避免使用同步 API 以保持非阻塞执行流。
-
输入/输出:当您修改 TypeScript 文件或讨论代码质量时,此技能将自动启用,并根据这些既定标准提供自动化检查。
仓库统计
- Star 数
- 75,828
- Fork 数
- 15,036
- Open Issue 数
- 740
- 主要语言
- TypeScript
- 默认分支
- main
- 同步状态
- 空闲
- 最近同步时间
- 2026年4月29日 08:37