0.0.18 • Published 1 year ago
zjh-ai-sdk-web v0.0.18
应用项目如果为 webpack 5 需安装 node-polyfill-webpack-plugin
环境要求
node 14.18.0以上
文档生成命令
npm run doc
sdk 代码打包
npm run build
项目引入
- web端
import api from "@zhs/zhs-ai-sdk-web
自动测试相关介绍
npm run test
- 自动化测试采用的是 jest 测试工具
- jest 开发文档
- 文件命名约束为: **.test.ts
代码 commit 规范
- feat: 新功能(feature)
- fix: 修补 bug
- docs: 文档(documentation)
- style: 格式(不影响代码运行的变动)
- refactor: 重构(即不是新增功能,也不是修改 bug 的代码变动)
- test: 增加测试
- perf: 优化相关
- chore: 构建过程或辅助工具的变动
组件命名发版规范
注意: 整体采用pnpm monorepo环境,整个环境请使用pnpm, packages和examples整个文件下共享组件和依赖。 如果后续添加新的文件,请在pnpm-workspace.yaml中添加
组件命名规则:zhs-xxx npm上传命名规则:package.json--name:"@zhs/zhs-xxx"
npm上传步骤 1. 登录 npm adduser --registry http://npm-registry.zhihuishu.com:4873/ 2. 发布 npm publish --registry http://npm-registry.zhihuishu.com:4873/
3.安装 npm install --registry http://npm-registry.zhihuishu.com:4873/