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