vue3-ep-biz-lib

vue3-ep-biz-lib

基于 Vue3 + Element Plus + TypeScript + SCSS + VitePress 的企业级业务组件库，工程规范对标 Element Plus。

在线文档 | Gitee 仓库 | npm 包

工程结构

packages/
├── components/     # 组件源码（每个组件独立目录：src/组件.vue + style/index.scss + index.ts）
├── hooks/          # 公共组合式函数
├── utils/          # 工具方法（withInstall / makeInstaller）
├── types/          # 全局 TS 类型定义
└── theme/          # SCSS 全局变量、Element Plus 主题变量复用

docs/
├── .vitepress/     # VitePress 配置 + 主题 + :::demo 容器插件
├── zh-CN/
│   ├── guide/      # 开发指南
│   └── components/ # 组件文档（md）
└── examples/       # 文档 demo 示例（组件名/示例名.vue）

命令

开发流程

日常开发在 dev 分支；需要部署文档时合并到 master（EdgeOne 生产分支）；发版用 npm run release。完整规范见开发流程指南。

新增组件三步

1. 在 packages/components/xxx-component/ 开发组件，index.ts 中 withInstall 导出；
2. 在 packages/components/index.ts 的 components 数组中注册；
3. 补充 docs/zh-CN/components/xxx-component.md 文档与 docs/examples/xxx-component/basic.vue 示例。

使用方式

全局注册

import { createApp } from 'vue'
import ElementPlus from 'element-plus'
import 'element-plus/dist/index.css'
import Vue3EpBizLib from 'vue3-ep-biz-lib'
import 'vue3-ep-biz-lib/dist/style.css' // 组件样式（npm 安装时必引）
import App from './App.vue'

const app = createApp(App)
app.use(ElementPlus)
app.use(Vue3EpBizLib)
app.mount('#app')

按需导入

<script setup lang="ts">
import { BizButton } from 'vue3-ep-biz-lib'
</script>

<template>
  <BizButton type="primary">按需导入</BizButton>
</template>

发布

统一命令（自动完成 release 分支、版本号、tag、构建、发布、合回 master）：

npm run release          # patch；minor/major/显式版本号：npm run release -- minor

完整流程与注意事项见 发布指南。