+ packages/`@astro/yyapi` 平台API `pc`、`mobile` + packages/`@astro/ui-components` ui库 + packages/`@astro/utils` 工具类 + packages/`@astro/pbproto` 交友服务器协议 + packages/`@astro/bytearray` 二进制读写库 + docs 用 `typedoc` 和 `rspress` 文档生成 + packages/`plugin-typedoc` typ
npm install astro-utils-workspace@astro/yyapi 平台API pc、mobile@astro/ui-components ui库@astro/utils 工具类 @astro/pbproto 交友服务器协议@astro/bytearray 二进制读写库typedoc 和 rspress 文档生成plugin-typedoc typedoc 插件json
{
"@astro/utils": "workspace:^",
}
`
$3
package.json 中添加包的本地地址,并执行 pnpm i
`json
{
"@friend/act-utils": "link:[ local path to act-utils]"
}
`发布
> 库之间依赖是通过 workspace:^, 用pnpm publish发布时,才能解析出正确的版本号;另外,需要加--no-git-checks参数, 否则会提示 git 仓库未提交, 导致发布失败。
`bash
pnpm publish --no-git-checks
`单元测试
`bash
pnpm test
`
> test后面可以测试用例名字,如:pnpm test abc, 那么只会跑单元测试文件名包含test关键字,如:abc.test.ts 的用例
> node 版本要求 >= 20
$3
1. 在模块目录下创建
README.md ,编写使用说明
2. 使用 typedoc 风格为导出的函数、类、public 方法等添加注释
3. 在 docs/rspress.config.ts 中配置文档生成路径
4. 将代码合并的 master 会自动生成文档,发布上线
#### 在线文档
访问在线文档获取详细的 API` 文档和使用示例。- 保持代码风格一致
- 编写完整的类型声明
- 添加必要的单元测试
- 及时更新文档