dolphindb-client-shared

DolphinDB 内部开发平台型应用的公共函数、组件、工具库，库本身的使用方式请参考在线文档，请注意，antd 版本需在 5.24.0 以上

安装

pnpm add dolphindb-client-shared

如何开发

源码和文档

库本身发布的源码内容请在 src 目录下进行开发，同时对于每一个模块（函数、组件、hooks），请为其添加对应的文档，文档请放置在 docs/pages/guide 目录下，若模块有可以演示的效果 Demo，统一放在 docs/demos 目录下。

开发时，可以使用以下命令启动文档服务器，以便于实时预览 Demo 效果：

pnpm docs:dev

发布相关

公共库可能会频繁更新和发布，但我们希望版本号以一个较为稳定的速度进行更新，因此对于为了某个项目进行的改动，我们将其视为不稳定的、可能会频繁修改的修改，建议在开发分支以 prerelease 的方式进行发布，main 分支仅用于发布稳定版本。

项目使用 changesets 进行修改记录和版本发布，因此在完成一个功能，提交代码（MR）前，请使用 pnpm change 命令来创建一个新的 changeset 记录，以便于在正式版发布时生成对应的 CHANGELOG。

关于如何处理预发布流程请参考：https://github.com/changesets/changesets/blob/main/docs/prereleases.md

文档

文档使用 rspress 进行开发，打包后的静态文件可以直接部署到任何静态服务器上。

项目对 rspress 的插件进行了一定程度的私有化定制，请在升级时注意检查定制是否与新版本代码冲突。