egg-huiju-gen-build v1.0.13

egg-huiju-gen-build

依赖的 egg 版本

命令使用介绍

• npm run build 生产环境打包发布

• npm run addview <viewname> : 添加页面，同时页面添加初始化后的controller、router。 可一次性添加多个页面，空格隔开就行，如：npm run addview home login ...

• npm run rmview <viewname> : 删除页面，同时删除对应controller、router文件。
• npm run addwidget <widgetname> : 添加公共组件。
• npm run rmwidget <widgetname> : 删除公共组件。
• npm run addwidget <widgetname> -- --page=<viewname> : 为页面添加页面组件。
• npm run rmwidget <widgetname> -- --page=<viewname> : 删除页面组件。
• npm run initviews : 根据配置项自动化构建 ;

自动化构建配置项：

配置方式：在page_conf/index.js中加入相关的页面构建配置。

• widget: Array 项目所包含公共组件数组，数组项为String则默认组件名，如果构建更深层级的组件文件夹，配置为Object；
  • name: String 组件名称；
  • path: String 组件文件夹路径；
• views: Array
  • path: String 页面文件夹路径；
  • router: String 页面路由，可选，无此项时根据path创建路由。
  • widget: Array 项目所包含页内组件数组。
  • api: Array 页面涉及接口
    • url: String 接口地址
    • method: String 请求方式
    • source: String 接口详细文档来源
    • payload: String 定义变量作为接收接口返回结果的载体，配置此项之后，将初始化对接接口代码到控制层函数中。
    • data: {} Object 请求参数，不传参时也定义为空对象
    • response: Object|Array 返回结果，可选，此项主要填写返回所需使用字段及相关注释。
  • template Array
    • controller String 定义控制层中该API请求的方法名
    • router String 定义该API路由
    • path String 所需异步渲染的模板路径，相对于views;
    • method String 定义请求方法
    • api Object 数据接口请求对象
      • url String 接口地址
      • method String 请求方法
      • menuList String 接收接口返回的载体

配置完成之后，执行npm run initviews即可自动构建项目所需页面、组件，并初始化好部分控制层代码。 也可在开发过程添加配置，然后重新执行即可增量添加相应组件及页面。对组件或者页面删除不可使用该方式，可以使用npm run rmwidget/rmview。
注意：删除之后记得同步更新配置项。