geekplus-digital-ui 0.1.0 → 0.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +0 -73
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,74 +1 @@
|
|
|
1
1
|
# Geekplus Digital UI
|
|
2
|
-
|
|
3
|
-
极智嘉数字化 Vue 3 组件库,基于 Element Plus 进行业务封装和样式定制。
|
|
4
|
-
|
|
5
|
-
## 在线文档
|
|
6
|
-
|
|
7
|
-
[https://ui.geekplus.cc/](https://ui.geekplus.cc/)
|
|
8
|
-
|
|
9
|
-
## 开发规范
|
|
10
|
-
|
|
11
|
-
本规范为组件库开发的基本原则与价值观,用于指导组件设计方向与技术选型。具体实现细则将随着组件库发展逐步补充。
|
|
12
|
-
|
|
13
|
-
1. 项目使用 pnpm 进行包管理。
|
|
14
|
-
2. 代码统一使用 ESLint 进行格式化,提交代码前请确保代码格式正确。
|
|
15
|
-
3. 开发请严格遵循 Vue 3 规范,推荐使用 Composition API。
|
|
16
|
-
4. 样式请使用 SCSS 编写,遵循 BEM 命名规范。
|
|
17
|
-
5. 组件国际化请使用 Vue I18n 进行处理。
|
|
18
|
-
6. 业务逻辑解耦,不得有与业务强耦合的代码及接口存在组件内。
|
|
19
|
-
7. 易于扩展和维护,组件设计需考虑复用性和可配置性。
|
|
20
|
-
8. 遵循 npm 包管理规范,确保版本控制清晰。
|
|
21
|
-
9. 文档请使用 VitePress 进行编写,确保文档清晰易懂。
|
|
22
|
-
10. 提交代码前请确保所有单元测试通过。
|
|
23
|
-
|
|
24
|
-
## 目录结构
|
|
25
|
-
|
|
26
|
-
开发核心目录说明:
|
|
27
|
-
|
|
28
|
-
- docs(文档目录)
|
|
29
|
-
- play(调试目录)
|
|
30
|
-
- packages(组件目录)
|
|
31
|
-
- components(组件集合)
|
|
32
|
-
- hooks(钩子函数集合)
|
|
33
|
-
- locale(国际化文件)
|
|
34
|
-
- utils(工具函数集合)
|
|
35
|
-
|
|
36
|
-
## 快速开始
|
|
37
|
-
|
|
38
|
-
### 安装依赖
|
|
39
|
-
|
|
40
|
-
```bash
|
|
41
|
-
pnpm install
|
|
42
|
-
```
|
|
43
|
-
|
|
44
|
-
### 启动调试
|
|
45
|
-
|
|
46
|
-
```bash
|
|
47
|
-
pnpm run dev
|
|
48
|
-
```
|
|
49
|
-
|
|
50
|
-
### 构建组件库
|
|
51
|
-
|
|
52
|
-
```bash
|
|
53
|
-
pnpm run build
|
|
54
|
-
```
|
|
55
|
-
|
|
56
|
-
### 运行文档
|
|
57
|
-
|
|
58
|
-
```bash
|
|
59
|
-
pnpm run docs:dev
|
|
60
|
-
```
|
|
61
|
-
|
|
62
|
-
### 构建文档
|
|
63
|
-
|
|
64
|
-
```bash
|
|
65
|
-
pnpm run docs:build
|
|
66
|
-
```
|
|
67
|
-
|
|
68
|
-
### 发布组件库
|
|
69
|
-
|
|
70
|
-
发布前请确保已正确设置 `package.json` 中的版本号及相关信息。
|
|
71
|
-
|
|
72
|
-
```bash
|
|
73
|
-
pnpm publish
|
|
74
|
-
```
|