贡献指南

发布

打包：

npm run build

发布：

- npm run release-patch && npm publish
+ 流水线发布

文档

根据jsdoc生成文档：

npm run docs:gen

JSDoc 编写注意事项

项目使用 jsdoc-to-markdown 生成 API 文档，JSDoc 的类型解析器（Catharsis）不支持部分 TypeScript 高级类型语法。编写 JSDoc 注释时请注意以下兼容性问题：

不支持的写法	替代方案	说明
@type {string | (() => Promise<Record<string, any>>)}	@type {string | Function}	箭头函数类型不被支持，用 Function 替代
@param {ReturnType<typeof getChalk>} chalk	@param {*} chalk	ReturnType<typeof X> 工具类型不被支持
@template T + @typedef {[T] | SomeType<T>}	移除 @template，保留 @example	元组字面量 [T] 不被支持

原则：TS 源码类型保持不变，只需调整 JSDoc 注释中的类型表达式，让 JSDoc 解析器不报错即可。复杂类型建议用 @example 代码示例来补充说明。

文档开发：

npm run docs:dev

文档打包：

npm run docs:build

文档部署：

npm run docs:deploy

单元测试

执行单元测试：

npm run test

打开测试报告：

open test/unit/coverage/lcov-report/index.html