elpis

一个企业级应用框架，通过全栈实现。

model配置

{
  mode: 'dashboard', // 模板类型，不同模板类型对应不同的模版数据结构
  // 头部菜单
  menu: [{
    key: '', // 菜单唯一标识
    name: '', // 菜单名称
    menuType: '', // 枚举值, group / module

    // 当 menuType 为 group 时， 可填 subMenu
    sebMenu: [{
      // 可递归 menuItem
    }, ...[]],

    // 当 menuType 为 module 时， 可填 menuItem
    moduleType: '', // 枚举值 sider/iframe/custom/schema

    // 当 moduleType 为 sider 时
    siderConfig: {
      menu: [{
        // 可递归 menuItem (除 moduleType === sider)
      }]
    },

    // 当 moduleType 为 iframe 时
    iframeConfig: {
      path: '', // iframe 路径
    },

    // 当 moduleType 为 custom 时
    customConfig: {
      path: '', // 自定义组件路径
    },

    // 当 moduleType 为 schema 时
    schemaConfig: {
      api: '', // 数据源 API (遵循 RESTful 规范)
      schema: {
        type: 'object',
        properties: {
          key: {
            ...schema,
            type: '', // 字段类型
            label: '', // 字段中文名
            tableOption: {
              ...elTableColumnConfig, // 标准 el-table-column 配置
              visible: true, // 默认为 true flase 时不在表单中显示，true 或 不配置时，在表单中显示
            },
            searchOption:{
              ...eleComponentConfig, // 标准 el-component 配置
              comType: '', // 配置标准组件类型 input/select/...
              default: '', // 组件默认值
              // comType === 'select' 时
              enumList: [], // 可选枚举项列表
              // comType === 'dynamic-select' 时
              api: '', // 异步获取可枚举项列表
            },
            // 字段在不同动态 component 中的相关配置，前缀对应 componentConfig 中的键值
            // componentConfig.createForm，这里对应 createFormOption
            // 字段在 createForm 中相关配置
            createFormOption: {
              ...eleComponentConfig, // 标准 el-component 配置
              comType: '', // 控件类型 input/select/input-number/...
              visible: true, // 是否展示 (true/false)，默认为true
              disabled: false, // 是否禁用 (true/false)，默认为false
              default: '', // 组件默认值

              // comType === 'select' 时
              enumList: [], // 可选枚举项列表
              // comType === 'dynamic-select' 时
              api: '', // 异步获取可枚举项列表
            },
            // 字段在 editForm 中相关配置
            editFormOption: {
              ...eleComponentConfig,
              comType: '', // 控件类型 input/select/input-number/...
              visible: true, // 是否展示 (true/false)，默认为true
              disabled: false, // 是否禁用 (true/false)，默认为false
              default: '', // 组件默认值

              // comType === 'select' 时
              enumList: [], // 可选枚举项列表
              // comType === 'dynamic-select' 时
              api: '', // 异步获取可枚举项列表
            },
            detailPanelOption: {
              ...eleComponentConfig
            }
          }
        },
        required: [] // 必填字段列表
      },
      tableConfig: {
        headerButtons: [{
          label: '', // 中文名
          eventKey: '', // 事件名
          // 事件具体配置
          eventOption: {
            // 当 eventKey === 'showComponent'
            comName: '', // 组件名称
          },
          ...elButtonConfig // 标准 el-button 配置
        }],
        rowButtons: [{
          label: '', // 中文名
          eventKey: '', // 事件名
          eventOption: {
            // 当 eventKey === 'remove'
            params:{
              // paramKey 为请求参数名，rowValueKey 为表格中当前行数据字段名
              // 当格式为 schema::tableKey 时，表示从表格中获取当前行数据字段值
              paramKey: rowValueKey
            }
          }, // 事件具体配置
          ...elButtonConfig // 标准 el-button 配置
        }]
      }, // table 表格配置
      searchConfig: {}, // search-bar 搜索配置
      // 动态组件 相关配置
      componentConfig: {
        // create-form 表单相关配置
        createForm: {
          title: '', // 表单标题
          saveBtnText: '保存'
        },
        // edit-form 表单相关配置
        editForm: {
          mainKey: '', // 主键字段名 - 用于修改时获取主键
          title: '', //表单标题
          saveBtnText: '保存', // 保存按钮文案
        },
        // detail-panel 相关配置
        detailPanel: {
          mainKey: '', // 主键字段名 - 用于展示时获取主键
          title: '' // 表格标题
        }
        // ...支持用户动态扩展
      },
    }
  }, ...[]]
}

服务端启动

const {
  serverStart
} = require('@dumpling_memory/elpis')

自定义服务端

• router-schema
• router
• controller
• service

前端构建

const { frontendBuild } = require('@dumpling_memory/elpis')

// 编译前端工程
frontendBuild(process.env._ENV)

自定义页面扩展

• 在 app/pages 目录下写入口 entry.xxx.js

dashboard / custom-view 自定义页面扩展

• 在 app/pages/dashboard/xxx 下写页面

dashboard / schema-view / components 动态组件扩展

1. 在 app/pages/dashboard/complex-view/schema-view/components 下写组件
2. 配置到 app/pages/dashboard/complex-view/schema-view/components/component-config.js

schema-form 控件扩展

1. 在 app/widgets/schema-form/complex-view 下写控件
2. 配置到 app/widgets/schema-form/form-item-config.js

schema-search-bar 控件扩展

1. 在 app/widgets/schema-search-bar/complex-view 下写控件
2. 配置到 app/widgets/schema-search-bar/search-item-config.js

提交规范

<type>(<scope>): <subject>

1. feat: 新功能 (feature)
2. fix: 修补 bug
3. docs: 文档 (documentation)
4. style: 格式 (不影响代码运行的变动)
5. refactor: 重构 (即不是新增功能，也不是修改bug的代码变动)
6. test: 增加测试
7. chore: 构建过程或辅助工具的变动
8. revert: 回滚到上一个版本
9. build: 打包
10. ci: 持续集成