快速开始
百度智能云 AI 团队「Acud Pro Components 公共库」「Acu React Common 公共库」「Acud 组件库」「AIFlow 可视化库」四合一集成文档。
1. Acud Pro Components 公共库
说明
百度智能云 AI 团队 React 公共部分集合,代码包括公共组件(common components)、业务组件(biz components)、高阶组件(HOC components)和工具集(utils)
1.1 安装
- npm
- yarn
npm install --save @baidu/acud-pro-components
yarn add @baidu/acud-pro-components -D
1.2 如何开发
# 规范检查
npm run lint
# 提交 commit
npm run cm
# 编译
npm run build
# 发版
npm run release
# 部署 npm
npm run deploy
# 生成文档
npm run build:doc
# 文档预览
npm run start
1.3 组件支持国际化开发
src/components/locale/index.tsx下补充对应组件国际化文案类型;src/compontents/locale对应翻译文档补充国际化文案;- 组件内部调用
useLocale获取对应国际化文案。
1.4 测试
理论上所有的公共库中的组件,方法都需要补齐测试用例,并且覆盖率需要达到 100%。 其中,工具集中的方法以单元测试为主,组件以 snapshot 测试为主。
# 测试脚本
npm run jest-test
1.5 提交流程
当你认为有组件、工具等需要放入 acud-pro 时:
- 进入开发阶段。代码在 src 下,文档在 demo 下;
- 通过
npm run cm提交代码,经 code review 后合入; - 自动继承部署 API 文档;
- 通过
npm run release命令发版,npm run deploy部署到 npm,或 @wangzixuan06 发布新版本,并进行通知。
2. Acu React Common 公共库
说明
百度智能云 AI 团队 React 公共部分集合,代码包括公共组件(common components)、业务组件(biz components)、高阶组件(HOC components)和工具集(utils)
2.1 安装
- npm
- yarn
npm install --save baidu-acu-react-common
yarn add baidu-acu-react-common -D
2.2 如何开发
# 规范检查
npm run lint
# 编译
npm run build
# 部署npm
npm run deploy
# 生成文档
npm run build:doc
# 文档预览
npm run serve
2.3 测试
理论上所有的公共库中的组件,方法都需要补齐测试用例,并且覆盖率需要达到 100%。其中,工具集中的方法以单元测试为主,组件以 snapshot 测试为主。
# 测试脚本
npm run jest-test
2.4 提交流程
当有组件、工具等需要放入 common 库时:
在 iCode 新建 issue,例如 【添加BOSUploader】
进入开发阶段,代码在 src 下,经 code review 后合入。
自动继承部署 API 文档。
@zhangzhe 发布新版本,并进行通知。
3. Acud 组件库
说明
百度智能云 AI 团队 Acud 组件库。
3.1 安装
- npm
- yarn
npm install --save acud
yarn add acud -D
3.2 引入
import {Button, Select} from 'acud';
3.3 样式
- 方式一:全局引入
- 方式二:webpack 插件引入
import 'acud/dist/acud.min.css';
// 在 bable 配置中使用 babel-plugin-import 插件,可实现组件和样式的按需加载
// libraryDirectory 也可以用 'lib'
['import', {libraryName: 'acud', style: true, libraryDirectory: 'es'}, 'acud']
4. AIFlow 可视化库
说明
AIFlow 是基于 ZRender 实现的图形绘制和交互库,可以实现节点和连线的新增、删除等操作,而且也支持拖拽等事件处理,主要用于机器学习组件配置可视化、流程可视化、结果可视化等场景。
4.1 安装
- npm
- yarn
npm install --save @baidu/aiflow
yarn add @baidu/aiflow -D
4.2 引入
import AIFlow from '@baidu/aiflow';