hy-logic-flow 1.0.4 → 1.0.6

package/README.md

@@ -1,123 +1,111 @@
-# Antdv 工作流组件 hy-flow-design
+yarn run dev
+# 使用npm
+# hy-logic-flow (hy-flow-design)
 
 <p align="center">
+  <a href="https://gitee.com/nirunfa/smart-flow-design">
+    <img src="https://img.shields.io/badge/repo-gitee-blue" alt="gitee">
+  </a>
   <a href="https://github.com/vuejs/vue">
     <img src="https://img.shields.io/badge/vue-2.7.16-brightgreen.svg" alt="vue">
   </a>
   <a href="https://github.com/vueComponent/ant-design-vue">
     <img src="https://img.shields.io/badge/Ant%20Design%20Vue-1.7.8-blue" alt="ant-design-vue">
   </a>
-  <a href="https://gitee.com/nirunfa/hy-flow-design/blob/master/LICENSE">
+  <a href="https://gitee.com/nirunfa/smart-flow-design/blob/master/LICENSE">
     <img src="https://img.shields.io/badge/license-Apache-blue" alt="license">
   </a>
-  <a href='https://gitee.com/nirunfa/hy-flow-design/stargazers'>
-     <img src='https://gitee.com/nirunfa/hy-flow-design/badge/star.svg?theme=dark' alt='star'/>
-  </a>
-  <a href='https://gitee.com/nirunfa/hy-flow-design/members'><img src='https://gitee.com/nirunfa/hy-flow-design/badge/fork.svg?theme=white' alt='fork'/>
-  </a>
 </p>
 
-![图片](https://gitee.com/nirunfa/hy-flow-design/raw/master/demo.jpg) ![图片](https://gitee.com/nirunfa/hy-flow-design/raw/master/setting.jpg)
+简体中文 | English (partial)
 
 ## 简介
 
-基于 vue、ant-design-vue 的自定义组件
-
-注：项目为 `vue2` 项目, 基于[github](https://github.com/smart-flow/hy-flow-design)这个项目根据公司某些独特的需求和组织架构进行了定制化的修改，在这里感谢这个作者！谢谢！
-- [码云](https://gitee.com/nirunfa/hy-flow-design)
-
-## 特性 <以下特性待整理>
-
-- 支持在线流程设计器，钉钉审批模式，中国式工作流
-- 支持流程办理、退回、自由流、会签、并行、串行、服务任务等
-- 支持退回任务，退回到指定环节，退回到上一步，退回到发起人
-- 支持转办任务，将任务交接给他人办理，办理完成后继续下一步骤
-- 支持委托任务，将任务委托给他人，他人办理完成后再回到委托人
-- 支持智能提交，相同处理人自动跳过，支持自由指定下一步处理人
-- 支持作废流程，允许发起人快速终止流程，管理员维护终止流程
-- 支持自由流程，根据环节选择，自由跳转到指定环节，特事特办
-- 支持流程撤回，下一步未办理的任务，可进行取回撤销重做任务
-- 支持流程跟踪图，流程状态展现，流转信息，任务历史，任务分配信息
-- 支持一个流程模型挂接多个业务单据，如某公司 8 种费用审批流程，表单不一样，但流程相同
-- 支持一个表单挂接多个流程环节，以表单角度去管理流程，方便业务理解
-- 支持全局表单，用于流程全局表单配置，目前支持内置表单、url 表单。如果不配置则发起流程会提示错误。
-- 支持节点表单，节点表单配置。如果不配置默认使用全局表单。
-- 流程事件脚本在线编写，包括：流程启动、完成、取消；任务分配、创建、结束等
-- 我的待办任务处理，我的已办任务、我创建的任务查询、流程跟踪、审批记录查询
-- 流程管控，在无关联表单情况下流程调试，如流程发起、挂起；流程定义、实例、任务等查询；任务办理，重定位等
-- 支持流程组件标签定义（流程按钮、意见审批、下一步流程信息等）快速与自定义的业务表单建立关系。
-- 支持版本化管理流程，新调整的流程业务不影响正在运行，未结束的流程继续流转。
-- 支持任务加签、催办任务、传阅任务、流程委托设置、流水号管理、常用语管理
-
-## 术语
-
-- **或签：** 一名负责人通过即可通过审批节点
-- **会签：** 需所有负责人通过才能通过审批节点
-- **加签：** 审批过程中加签
-  - 前加签：在当前任务的前面加签，如果选择此操作，则当前待办会消失，等待选择的加签人审批后才能办理当前任务。
-  - 后加签：即在当前任务的后面加签，选择此操作后会将任务发送给选择的加签人审批，加签人审批后再发给流程设计的下一步人审批。
-  - 并签：即和当前任务并列审批。
-- **委托(派)：** 将任务委托给他人处理，他人办理完成后再回到委托人的任务中
-- **转交：** 将审批单转交给指定人处理，直接将办理人换成别人，这时任务的拥有着不再是转办人
-- **签收：** 一般情况就是多个候选人，或者候选组的情况下，要先把这个任务签收下来，以免别人又做了同样的任务
-- **反签收：** 就是把执行人设置为空
-  - 注意事项：反签收的时候，一定要先确定是否有候选人或者候选组，如果没有的话，不能反签收。因为会导致这个任务无法认领。
-
-#模块安装
-
-## 组件
-
-- FlowDesign 流程设计
-
-## 发布
-
-```cmd
-npm login
+`hy-logic-flow`（仓库名：`smart-flow-design`）是一个基于 Vue 2 + Ant Design Vue + Logic-Flow 的流程设计与流程组件库，封装了流程设计器、流程执行与常见工作流功能，方便在企业级应用中集成可视化流程管理能力。
 
-npm publish
-```
+主要功能摘要：流程定义/设计、节点表单配置、任务办理、退回/转办/委托、会签/或签、并行分支、流程跟踪、流程版本管理等。
 
-## 本地运行
+仓库地址（码云）： https://gitee.com/nirunfa/smart-flow-design
 
-```cmd
-# 使用yarn
-yarn install
+## 目录结构（简要）
 
-yarn run dev
+- `packages/`：库入口与 mini 版本实现
+- `FlowDesign/`：流程设计相关视图与逻辑
+- `FlowNode/`：各类流程节点实现
+- `Common/`、`Component/`：可复用组件
+- `examples/`：示例用法和演示页面
 
-# 使用npm
+更多目录请参阅仓库根目录。
+
+## 快速开始
+
+安装（npm / yarn）：
+
+```bash
+# 使用 npm
 npm install
 
+# 或使用 yarn
+yarn install
+```
+
+本地开发：
+
+```bash
 npm run dev
+# 或
+yarn run dev
 ```
 
-## 插件安装
+构建分发库（生成 `dist`）：
 
-```cmd
-# 使用yarn
-yarn add hy-logic-flow
+```bash
+# 构建主库
+npm run lib
 
-# 使用npm
+# 构建 mini 版本（仅库，体积更小，需项目已引入 antd 组件）
+npm run mini
+```
+
+发布到 npm（示例）：
+
+```bash
+npm login
+npm publish
+```
+
+（仓库还提供 `scripts/publish.js` 与 `scripts/publish-mini.js` 可选的发布自动化脚本）
+
+## 在项目中使用
+
+安装已发布的包：
+
+```bash
+# 完整包：
 npm i hy-logic-flow --save
+
+# 或 mini 包（前提：项目中已包含 Ant Design Vue）：
+npm i hy-logic-flow-mini --save
 ```
 
-## 引入组件
+在 `main.js` 中引入并注册：
 
 ```javascript
-// 在main.js引入
-import HyFlowDesign from 'hy-logic-flow;
-import 'hy-logic-flow/styles/hy-logic-flow.less';
-Vue.use(HyFlowDesign);
-
-// 注册 flowStore 到 Vuex
-const flowStore = HyFlowDesign.flowStore;
-console.log(flowStore)
-if (flowStore) {
-    store.registerModule('flow', flowStore);
+import Vue from 'vue'
+import HyFlowDesign from 'hy-logic-flow'
+import 'hy-logic-flow/styles/hy-logic-flow.less'
+
+Vue.use(HyFlowDesign)
+
+// 可选：将内部提供的 flow store 注册到你的 Vuex
+const flowStore = HyFlowDesign.flowStore
+if (flowStore && !$store.state.flow) {
+  // 假设你的 Vuex 实例为 store
+  store.registerModule('flow', flowStore)
 }
 ```
 
-## 使用组件
+在组件中使用：
 
 ```html
 <template>
@@ -127,38 +115,40 @@ if (flowStore) {
 </template>
 ```
 
-## 引入 mini 包
+示例请参考 `examples/` 目录。
 
-默认包是集成了 antd ui 的，如果项目中也有使用 antd ui，可以选择引入 mini 包来达到减小最终项目的体积，当然要确认项目中已经引入 components_use.js 中的组件使用
+## 可用脚本（来自 `package.json`）
 
-```javascript
-- import HyFlowDesign from 'hy-logic-flow-mini';
-+ import HyFlowDesign from 'hy-logic-flow-mini/lib/hy-logic-flow-mini-mini.umd.min'
-import 'hy-logic-flow-mini/lib/hy-logic-flow-mini.css'
-Vue.use(HyFlowDesign)
+- `npm run dev`：本地开发（vue-cli 服务）
+- `npm run build`：构建示例/站点
+- `npm run lib`：构建为库（lib）并同时触发 mini 构建
+- `npm run mini`：生成 mini 包库文件
+- `npm run lint`：运行 ESLint
+- `npm run pub`：自定义发布脚本（`scripts/publish.js`）
 
-// 注册 flowStore 到 Vuex
-const flowStore = HyFlowDesign.flowStore;
-console.log(flowStore)
-if (flowStore) {
-    store.registerModule('flow', flowStore);
-}
-```
+完整脚本请查看 `package.json`。
 
-```node
-# 构建mini,生成lib目录
-yarn run mini
+## 注意与建议
 
-# 在lib的文件发布到npm
-npm login
+- 本项目基于 Vue 2.x（使用 `vue@2.7.x` 与 `vue-template-compiler@2.7.x`）。
+- 如果你的项目已使用 Ant Design Vue，建议使用 `hy-logic-flow-mini`（mini 包）以减小 bundle 体积。
+- 如果要定制节点、表单或事件脚本，请阅读 `FlowDesign/` 与 `FlowNode/` 下的实现并结合 `examples/` 调试。
 
-npm publish
-```
+## 贡献
+
+欢迎提 PR 和 issue。建议先在本地运行并按照仓库代码风格提交（项目包含 ESLint / Prettier / Stylelint 配置）。
+
+常见贡献流程：
+
+1. Fork 本仓库并创建分支
+2. 编写代码并遵循现有代码风格
+3. 提交 PR 并在 PR 描述中说明变更点
 
-## 字体资源地址
+## 许可证
 
-[FiraCode 和 Operator Mono 字体下载地址](https://gitcode.net/mirrors/beichensky/font)
+Apache License
 
-## License
+更多信息请查看仓库 LICENSE 文件。
 
-[Apache](https://gitee.com/nirunfa/hy-flow-design/blob/master/LICENSE) Copyright (c) 2022 
+---
+文件位置： [README.md](README.md)