Skip to content

Commit 49968c1

Browse files
feat: 添加打包配置
1 parent 41efcb4 commit 49968c1

File tree

5 files changed

+24385
-5
lines changed

5 files changed

+24385
-5
lines changed

.gitlab-ci.yml

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
2+
default:
3+
image: node:latest
4+
before_script:
5+
- |
6+
{
7+
echo "@miniapp:registry=${CI_API_V4_URL}/packages/npm/"
8+
echo "${CI_API_V4_URL#https?}/packages/npm/:_authToken=\${CI_JOB_TOKEN}"
9+
echo "@${CI_PROJECT_ROOT_NAMESPACE}:registry=${CI_API_V4_URL}/projects/${CI_PROJECT_ID}/packages/npm/"
10+
echo "${CI_API_V4_URL#https?}/projects/${CI_PROJECT_ID}/packages/npm/:_authToken=\${CI_JOB_TOKEN}"
11+
echo "registry=https://registry.npmmirror.com/"
12+
} | tee --append .npmrc
13+
- yarn install
14+
cache:
15+
key: ${CI_COMMIT_REF_SLUG}
16+
paths:
17+
- .npm/
18+
19+
#workflow:
20+
# rules:
21+
# - if: $CI_COMMIT_BRANCH
22+
23+
24+
# 环境变量
25+
variables:
26+
NPM_TOKEN: ${CI_JOB_TOKEN}
27+
28+
29+
# 定义构建流程
30+
stages:
31+
- deploy
32+
# - notification
33+
34+
35+
# 部署到 Kubernetes 集群 - 测试环境
36+
deploy:
37+
stage: deploy
38+
only:
39+
- main
40+
script:
41+
- sh ./ADAPT.sh
42+
43+
44+
# 构建完成的消息通知
45+
# notification:
46+
# stage: notification
47+
# only:
48+
# - main
49+
# script:
50+
# - latestTag=$(git describe --tags $(git rev-list --tags --max-count=1))
51+
# - >-
52+
# curl 'https://oapi.dingtalk.com/robot/send?access_token='$DINGTALK_AT_WEB''
53+
# -H 'Content-Type: application/json'
54+
# -d '{
55+
# "msgtype": "actionCard",
56+
# "actionCard": {
57+
# "title": "'$CI_PROJECT_NAME' '$CI_COMMIT_TAG'版本发布成功",
58+
# "text": "![npm](https://image.biubiukam.com/kk/npm/npm-template.png) \n\n#### '$CI_PROJECT_NAME' 发布成功 \n发布版本: **'$latestTag'**,请使用本包开发者自行选择对应版本更新。",
59+
# "btnOrientation": "1",
60+
# "btns": [
61+
# {
62+
# "title": "更新记录",
63+
# "actionURL": "dingtalk://dingtalkclient/page/link?url=https%3A%2F%2Fgit.kkgroup.cn%2Ffeb%2F'$CI_PROJECT_NAME'%2F-%2Fblob%2Freleased%2FCHANGELOG.md&pc_slide=false"
64+
# },
65+
# {
66+
# "title": "项目说明",
67+
# "actionURL": "dingtalk://dingtalkclient/page/link?url=https%3A%2F%2Fgit.kkgroup.cn%2Ffeb%2F'$CI_PROJECT_NAME'%2F-%2Fblob%2Freleased%2FREADME.md&pc_slide=false"
68+
# }
69+
# ]
70+
# },
71+
# "at": {
72+
# "atMobiles": [],
73+
# "isAtAll": false
74+
# }
75+
# }'

ADAPT.sh

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
yarn build
2+
cd apps/plate-editor
3+
yarn semantic-release

ADAPT_README.md

Lines changed: 119 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,119 @@
1+
2+
3+
# 1. 适配文件分层清单
4+
5+
## 1.1 业务层 demo
6+
7+
`apps/plate-editor/src/registry/examples/playground-demo.tsx`
8+
9+
`apps/plate-editor/src/registry/components/editor/plugins/sharedb-kit.tsx`
10+
11+
## 1.2 业务层 基础包
12+
13+
`apps/plate-editor/package.json`
14+
15+
```
16+
"vite": "^5.2.0",
17+
"vite-plugin-dts": "^3.9.0",
18+
"vite-plugin-imp": "^2.4.0",
19+
"@rollup/plugin-commonjs": "^25.0.7",
20+
"@rollup/plugin-node-resolve": "^15.2.3",
21+
"@vitejs/plugin-react": "^4.2.1"
22+
```
23+
24+
`apps/plate-editor/vite.config.ts`
25+
26+
`apps/plate-editor/main.ts`
27+
28+
`apps/plate-editor/app.ts`
29+
30+
`apps/plate-editor/src/registry/ui/block-draggable.tsx`
31+
32+
33+
## 1.3 业务层 路由/套件
34+
35+
`apps/plate-editor/src/kk-adapt-plugin-kit.tsx`
36+
37+
`apps/plate-editor/index.html`
38+
39+
40+
## 1.4 导出层级
41+
42+
`apps/plate-editor/src/kk-adapt-export.ts`
43+
44+
45+
# 2. 适配功能清单
46+
47+
48+
49+
1. '@platejs/utils-custom'
50+
1. ->TrailingBlockPlugin 添加 match 功能
51+
2. sharedb ot 逻辑
52+
3. draggle 添加 "+" 添加元素 设计
53+
54+
# 3. 开发者须知
55+
56+
## 3.1 仓库
57+
58+
建议各个开发者开发时候拥有如下仓库
59+
60+
- 后端(见`packages/sharedb/demo/server`): 用来模拟后端
61+
- plate:修复基础功能和做适配层。
62+
- teamshare 最小demo: 因为teamshare版本太老了,很容易出问题。因此最好自己抽离一个小版本验证
63+
64+
65+
66+
# 5. 项目时间线
67+
68+
## 5.1 mvp版本
69+
70+
这一部分的目的在于用plate重构前端云文档插件协同逻辑和核心hooks
71+
构建 mvp 版本
72+
73+
1. 编写sharedb插件(原来的plate并没有sharedb相关的逻辑) ✅
74+
2. 编写后端最小mvp用于测试 ✅
75+
3. 初步接入协同系统
76+
1. ot 逻辑注册进 sharedb ✅
77+
2. 房间成员管理
78+
3. 鼠标协作逻辑.
79+
4. 引入心跳 ✅
80+
4. 编写上游协同逻辑(为了能够跟踪上游plate的更新)。构建打包策略
81+
5. 天书测试环境构建新路由,引入mvp版本
82+
83+
## 5.2 新文档组件功能增强
84+
85+
这一部份的目的在于对于我们原来功能 云文档有的功能 而 plate 的插件做扩展。
86+
其中包含两个方面。适配和增强。
87+
88+
适配的含义是: 后续新增的数据都会用plate的组件,但是之前的组件数据结构 也会得到保持并且渲染
89+
适配的组件包括:
90+
1. 资源文件: 图片/视频/音频/文件。这部分其实plate插件有,但是需要针对我们的场景做适配
91+
2. 列表
92+
2.1 有序
93+
2.2 无序
94+
2.3 待办
95+
3. 超链接
96+
4. mention: @组件
97+
5. 引用
98+
6. 代码块
99+
7. 分栏
100+
8. ai组件
101+
9. 表格
102+
103+
增强的含义是: 针对于旧云文档有,但是platejs本身不支持的组件做插件引入
104+
增强的组件包括
105+
1. 流程图
106+
2. uml 图
107+
3. 文本绘图
108+
4. 公式
109+
110+
## 5.3 新文档业务逻辑适配
111+
112+
1. 评论
113+
2. 页宽
114+
3. 历史记录
115+
4. 只读模式: 用于知识库预览等场景
116+
5. 语音速记
117+
6. 国际化
118+
7. 离线模式
119+

apps/plate-editor/package.json

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@
1818
"package.json"
1919
],
2020
"scripts": {
21+
"semantic-release": "semantic-release",
2122
"start": "next dev --port 4900",
2223
"dev": "vite --host",
2324
"build": "NODE_OPTIONS='--max-old-space-size=8192' vite build",
@@ -106,8 +107,7 @@
106107
"@radix-ui/react-toggle-group": "1.1.10",
107108
"@radix-ui/react-toolbar": "1.1.10",
108109
"@radix-ui/react-tooltip": "1.2.7",
109-
"@rollup/plugin-commonjs": "^25.0.7",
110-
"@rollup/plugin-node-resolve": "^15.2.3",
110+
111111
"@shikijs/compat": "1.1.7",
112112
"@slate-yjs/react": "1.1.0",
113113
"@tabler/icons-react": "3.34.0",
@@ -116,7 +116,6 @@
116116
"@udecode/cmdk": "*",
117117
"@udecode/cn": "*",
118118
"@uploadthing/react": "7.3.1",
119-
"@vitejs/plugin-react": "^4.2.1",
120119
"ai": "4.3.16",
121120
"autoprefixer": "10.4.21",
122121
"class-variance-authority": "0.7.1",
@@ -193,11 +192,14 @@
193192
"unist-util-visit": "5.0.0",
194193
"uploadthing": "7.7.2",
195194
"use-file-picker": "2.1.2",
195+
"y-webrtc": "10.3.0",
196+
"zod": "3.25.61",
196197
"vaul": "1.1.2",
197198
"vite": "^5.2.0",
198199
"vite-plugin-dts": "^3.9.0",
199200
"vite-plugin-imp": "^2.4.0",
200-
"y-webrtc": "10.3.0",
201-
"zod": "3.25.61"
201+
"@rollup/plugin-commonjs": "^25.0.7",
202+
"@rollup/plugin-node-resolve": "^15.2.3",
203+
"@vitejs/plugin-react": "^4.2.1"
202204
}
203205
}

0 commit comments

Comments
 (0)