Appearance
editor
关闭事件触发、hover效果等编辑内不需要的功能。眼下有好几种方案。
组件/插件包第三方化
单组件仓库 改为 多组件仓库
开发环境仍要手动导umd.js
,因为前端项目只能指定路径而不能全部导入或者正则匹配。
一个简单的思路是做成接口,需要后端返回对应脚本url数组,但这样对第三方开发并不友好。不过这种形式以后一定会用到,可以留意。
另一个简单的思路就是将每个仓库只能有一个组件改为每个仓管可以有多个组件,当组件增删时,不需要自己手动添加或删除。
加之创建仓库其实是很麻烦的操作,与高效开发背道而驰。于是采用了上面的方案二。
这样做的好处还有大幅减少体积。以下是image、button和包含以上两个组件的core打包后的大小:
不过限制也有,那就是插件包信息必须是全量导入的。幸好导入的只是信息(包含了脚本地址),而不是组件,所以注意不要全量挂载即可。
配置外置化
编辑器不应有任何关于组件、package的配置,目前编辑器和packages是耦合在一起的,编辑器内置了组件的类型、ID、历史版本,这些信息后续都会放到packages配置组件的地方,确保一个组件的ID、版本号等唯一信息不要出现在两个地方。
其实观察/editor/src/data下的文件,其中都是配置,合理的获取方式要么是后端传过来,要么是在组件仓库里,而不能与编辑器藕合在一块。
由于source属性完全由id和version加上文件后缀组成,因此不需要这个属性了。
整合后,插件包的核心属性如下:
javascript
export default {
id: 'core', // 唯一id,支持同id的包对此进行扩展
version: '0.0.3', // 版本号
name: '基础组件', // 分类名
type: 'core', // 分类
components: {
'lc-button': () => import("./lc-button"),
'lc-image': () => import("./lc-image"),
}
}
自动构建
为提升第三方开发体验,需对现有的build模式改造。
原先加载umd.js
的方式为:构建完成后,手动拖到editor/public
,再注册脚本,编辑器又根据预设好的物料对组件进行默认渲染。
手动改自然是低效的,vite提供了指定打包路径的构建选项:
TypeScript
import {defineConfig} from 'vite'
import vue from '@vitejs/plugin-vue';
import pkg from './package.json'
export default defineConfig({
plugins: [vue()],
build: {
lib: {
entry: './src/index.ts',
name: 'core',
fileName: `${pkg.name.split('/')[1]}.${pkg.version}`,
formats: ['umd'],
},
cssCodeSplit: true,
outDir: '../../apps/editor/public'
},
})
这样就会构建到编辑器目录下。
开发过程中,为减少反复手动build,我们给vite build
加一个参数--watch
:
json
{
"name": "@lowcode512/core",
"version": "0.0.3",
"main": "./dist/index.cjs",
"module": "./dist/index.mjs",
"types": "./dist/index.d.ts",
"exports": {
".": {
"import": "./dist/index.mjs",
"require": "./dist/index.cjs"
}
},
"publishConfig": {
"access": "public"
},
"files": [
"dist"
],
"scripts": {
"build": "vite build"
"build": "vite build --watch"
},
"keywords": [
"low-code",
"typescript"
],
"license": "MIT"
}
到此,组件到编辑器的自动化链路就可用了。
INFO
后续还可尝试自动导入组件
组件聚合
在之前的改造中,我们将index.ts
、index.vue
和index.css
聚合为一个.ts
和一个.vue
,这样仍要由.ts
导入.vue
,然后在包的总配置里再import
。
能否将.ts
和.vue
也聚合一下,减少导入步骤?
这里第一版方案是JSX
,vite内置了babel,安装插件@vitejs/plugin-vue-jsx
即可开始使用JSX
。
ts
import {defineConfig} from 'vite'
import vue from '@vitejs/plugin-vue';
import vueJsx from "@vitejs/plugin-vue-jsx";
import pkg from './package.json'
export default defineConfig({
plugins: [vue(), vueJsx()],
plugins: [vue(), vueJsx()],
build: {
lib: {
entry: './src/index.ts',
name: 'core',
fileName: `${pkg.name.split('/')[1]}.${pkg.version}`,
formats: ['umd'],
},
cssCodeSplit: true,
outDir: '../../apps/editor/public'
},
})
tsx
import { createProp } from './utils'
const render = {
setup() {
return () => <div>TSX</div>;
}
}
export default {
render,
editorProps: {
title: createProp<FormMap.Input>({
defVal: '请输入文字',
label: '内容',
})
}
};