Skyroc 基础设施层文档入口,覆盖工具函数、请求、状态、任务调度、色彩、设计令牌、日志、全局类型与工程脚本等核心包
packages/@core 是项目的基础设施层,用来承载跨平台、低业务耦合、可以独立发布或复用的核心能力包。
这些文档面向在业务应用、组件库、文档站和工程工具中复用基础能力的开发者,重点说明每个包解决什么问题、应该从哪里导入、以及与其他核心包的关系。
平台无关工具函数集合,包含日期、事件、数组、对象、路径、并发去重,以及 web / path / crypto / cn 四个子入口。
类型安全的 Axios 请求客户端工厂,提供业务响应适配、错误处理、重试和请求取消能力。
请求与查询基础设施,通过平台适配器接入 UI、鉴权、导航、React Query 与接口传输加密。
基于 Jotai 的状态管理封装,支持全局 store、持久化原子和组件外访问。
面向设计系统和主题引擎的色彩工具包,提供调色板生成、颜色转换和无障碍对比度能力。
设计令牌的唯一来源:Tailwind 插件形式输出 CSS 变量主题、12 套内置配色与语义 token,Web / Native 双平台共用。
基于 LogLayer 的跨端日志系统,覆盖本地落盘、白名单上传与按保留期清理。
零运行时的全局类型声明包,通过 declare global 注入 Api / App / Router 等命名空间。
Skyroc Admin CLI 工具集,覆盖提交规范、发版、changelog、依赖更新、模板生成和产物清理。
| 场景 | 优先使用 |
|---|---|
| 通用工具函数、日期、事件、路径读写等能力 | @skyroc/utils |
| 浏览器专用能力(下载、存储、开窗、DOM 类名) | @skyroc/utils/web |
| 只需要一个类型安全的 HTTP 客户端 | @skyroc/axios |
| 需要业务错误处理、Token 刷新、React Query 和平台适配 | @skyroc/service |
| 需要跨组件或组件外访问的状态管理 | @skyroc/core-state |
| 需要统一调度启动任务、定时任务或监听器 | @skyroc/utils/scheduler |
| 需要生成主题色、暗色模式色板或做 WCAG 对比度检测 | @skyroc/color |
| 需要给 Web 或 Native 注入设计令牌、切换整套配色 | @skyroc/tailwind-plugin |
| 需要日志落盘、灰度上报或离线补传 | @skyroc/logger |
需要免 import 的全局 Api.* / Router.* 类型 | @skyroc/types |
| 需要项目自动化命令、提交引导、发版或 changelog | @skyroc/scripts |
types (纯类型,零运行时,任何包都可依赖)
↑
utils
↑
color / axios / logger
↑ ↑
| service
tailwind-plugin (构建期消费 color,被 Web / Native 两侧共同引入)
state / scripts 相对独立,按具体业务场景引入。依赖方向应保持从基础能力到上层组合能力,不应让底层包依赖业务包、UI 包或上层服务包。
Last updated on