KnowDesign

一个基于 Antd-v4 所封装的业务组件库

文档

Knowdesign文档地址

Features

- 支持 TypeScript
- 支持 单元测试 Jest + @testing-library/react
- 支持 less
- 支持 eslint & prettier
- 支持 react-app-rewired
- 基于 umijs/father 完成打包，可使用 cjs、esm 和 umd 三种格式的引用

Installation

``
$ npm install knowdesign
`

Usage

`


开发文档

$ npm run start

组件测试

$ npm test

文档构建

$ npm run site

文档发布

$ npm run deploy

打包

$ npm run build
`

目录结构

`
── README.md
├── build.sh
├── config-overrides.js
├── docs // 文档
| ├── changeLog.md
| └── introduce.md
├── elevate
| └── pipeline.doc.yml
├── es
├── jest.config.js
├── lib
├── package-lock.json
├── package.json
├── public // 公共文件
├── scripts // 构建用到的脚本
├── server.conf // 用于部署的 Nginx 配置
├── src
| ├── App.tsx
| ├── config.tsx // 路由等配置
| ├── index.tsx
| ├── pages // 开发组件的地方
| ├── demos // 写Demo的地方
| |—— components // 写组件的地方
| | ├── empty-line
| | | ├── EmptyLine.tsx // 组件
| | | ├── __tests__ // 测试目录
| | | | └── index.test.tsx
| | | ├── index.tsx // 组件入口
| | | ├── style // 组件样式
| | | | ├── index.less
| | | | └── index.tsx
| | | └── demo // 文档
| | | └── basic.md
| | └── index.tsx
├── test-report.html 测试报告
└── tsconfig.json
`

组件

$3

在 components 目录下，新增一个组件的目录，类似上面的 empty-line 组件。目录名需要保持小写。如果是自定义组件，需要取一个 antd 中所不包含的组件名称。添加完文件之后，在 entry/config.tsx 中增加 demo 的配置。此时应该可以看到组件，并继续开发了。

更多请参考：手摸手，打造属于自己的 React 组件库 —— 基础篇

$3

测试文件需要保持 .test.tsx 的后缀。相关技术栈以及文档：

- Jest：JavaScript 测试框架。
- @testing-library/react：将 React 组件转化成 Dom 节点来测试，而不是渲染的 React 组件的实例，可以当做是 Enzyme 的替代。编写测试脚本，并保证希望测试到的地方已经覆盖。

更多请参考：手摸手，打造属于自己的 React 组件库 —— 测试篇

$3

`
$ npm run build
$ npm login
$ npm version patch
$ git push
$ npm publish
`

> npm version
- major：主版本号
- minor：次版本号
- patch：补丁号
- premajor：预备主版本
- prepatch：预备次版本
- prerelease：预发布版本

文档

$3

在组件的 demo 文件夹中添加 .md 文件开发文档，并运行命令查看效果

`
npm start
`

$3

`
npm run site
``