OneCode VSCode Plugin

OneCode前端设计器是GCommon低代码平台的VSCode插件实现, 目前提供模版可视化配置功能，支持一键生成本地工程Vue2文件，为前端开发提效。

使用/Usage

在侧边栏-资源管理器中点击鼠标右键，然后点击"使用OneCode创建页面"菜单项，即可打开OneCode前端设计器

功能/Features

支持可视化列表模版配置, 支持根据业务类型快速配置
可导出Vue2 SFC单文件组件

插件配置/PluginConfiguration

在【文件】> 【首选项】> 【设置】中配置

OneCode.token

OneCode前端设计器插件token, 必需配置, 否则可能会导致模版相关数据获取失败可通过点击此处获取token信息

OneCode.url

OneCode前端设计器远程链接, 此配置可忽略

功能本地配置/LocaleConfiguration

当用户首次打开插件时，会在用户工程根目录下生成onecode.config.js文件, 此文件主要用来说明用户模版中使用API数据来源以及用户API包装类规则等，方便能够正确解析业务后端提供的API接口数据

默认配置内容如下, 可根据业务规则修改

/**
 * This is the main configuration file for OneCode VSCode Plugins.
 */
module.exports = {
  /**
   * API数据源配置，通过配置数据源地址，支持用户通过API接口字段与模版绑定
   * API数据源地址支持配置swagger在线地址或noah接口文档地址
   * 如果是noah文档，建议用户从noah接口文档导出JSON文件然后放在项目根目录
   * 例如: 
   * dataSource: [
   *  {
   *    type: 'swagger',
   *    url: 'https://onecode-dev.wanyol.com/user-service/restdocs/v3/api-docs'
   *  },
   *  {
   *    type: 'noah',
   *    url: 'api.json' // api.json为noah接口导入到本地的接口文档地址
   *  }
   * ]
   */
  dataSource: []

  /**
   * API包转类解析规则配置, 支持不同类型接口的包装类解析规则
   * 支持正则匹配接口路径
   */
  apiPackageResolver: {
    //接口路径匹配规则，支持正则
    '/api/system1/': {
      // 响应数据包装类解析规则配置
      httpResponse: {
        // 正常响应条件
        successExpress: '$.response.status==200&&$.response.body.code==0',
        // 正常响应数据实体位置
        dataKey: '$.response.body.data',
        // 响应信息位置
        msgKey: '$.response.body.msg',
        // 分页接口返回总数Key值
        pageTotalKey: 'total',
        // 分页接口返回列表数据Key值
        pageDataKey: 'rows'
      }
    },
    // 支持配置不同接口路径包装类响应规则
    '/api/system2/': {
      httpResponse: {
        successExpress: '$.response.status==200',
        dataKey: '$.response.body',
        pageTotalKey: 'total',
        pageDataKey: 'list' 
      }
    }
  }
}

更新日志/Change Log

1.0.0

支持通用列表模版

异常编码

00001: 获取根目录信息失败！
00002: 解析配置文件失败, 请确保配置文件格式正确!
00003: 您当前工程目录下没有onecode.config.js配置文件, 请先创建该文件！
00004: 获取配置文件失败!
00005: 创建配置文件失败!

Enjoy!

OneCode

gcommon-team