cube-macro

cube-macro是一个用来批量生成同类cube的工具。

介绍

在开发cube时，会遇到开发多个相同样式及逻辑的cube，其中只有某些数据值有所差异。 使用cube-macro可避免手动创建多个cube的低效操作，以及对项目数据进行结构化管理与维护。

安装

npm安装

npm install --save-dev git+https://github.com/ntt360/cube-macro.git

可被nodejs项目引入

const path = require('path');
const cubeMacro = require('cube-macro');
const config = require('../tpl/data.config.js');

cubeMacro({
  templatePath: path.resolve(__dirname, '../tpl'),
  outputPath: path.resolve(__dirname, '../dist'),
  config
}).then(() => console.log('Finished'));

参数

Options <Object>

• templatePath <Path> ： 指定模板路径。
• outputPath <Path> ： 指定输出路径。
• watch <Boolean> : 监测模板更改，并重新构建。
• config <Array|Function<Array|Promise>> ： 配置数据

使用

• 创建tpl目录（或自定义模板目录），并创建模板文件模板文件。
• 在tpl下创建配置文件data.config.js。
• 可通过nodejs调用或npm script运行cube-macro -t ./tpl -o ./dist
• 构建产物输出到dist目录

具体请参考./tpl目录示例

注：可通过cubetool工具来创建指定模板：

cubetool init <cubeid> -t <template>

模板变量

在模板文件内，可通过__key__的形式定义模板变量，并与data.config.js里配置的数据进行映射，同时，还可通过定义表达式__(expression)__来处理模板变量。

配置文件说明

配置文件需要导出一个函数，并且函数需返回数组（如需异步处理，可返回promise），数组内元素即为单个cube相关配置，可定义为对象字面量形式。

属性：

• project：项目相关配置
• cube：针对cube.json数据配置
• api：针对api.json数据配置
• data：对src下数据配置，数据替换已忽略二进制文件

module.exports = function ({ isProd }) {
  const config = [
    {
      project: {
        dirName: 'game' // 定义输出目录名称，
      },
      cube: {
        id: 'game-id',
        version: '1.0.1',
        name: 'game-name',
        idn: 'game-idn'
      },
      api: {
        host: 'https://groot.hao.360.cn/api/cube/articleList',
        offlineData
      },
      data: {
        cubeName: 'game-cube-name',
        showId: 'XXXXXX',
        result: {
          msg: "success"
        },
        offlineData
      }
    },
    {
      project: {
        dirName: 'edu'
      },
      cube: {
        id: 'edu-id',
        version: '1.1.0',
        name: 'edu-name',
        idn: 'edu-idn'
      },
      api: {
        host: 'https://groot.hao.360.cn/api/cube/articleList',
        offlineData
      },
      data: {
        cubeName: 'edu-cube-name',
        showId: 'XXXXXX',
        result: {
          msg: "success"
        },
        offlineData
      }
    },
  ];

  return config;

  // 异步获取配置数据可返回promise，可用来通过接口拿到兜底数据
  // return new Promise((resolve, reject) => {
  //   setTimeout(() => {
  //     resolve(config)
  //   }, 1000);
  // });

}

参考

模板定义：

var showId = '__showId__'
var result = '__result__'
var msg = '__result.msg__'
var msg = '__cubeName + "|" + result.msg__'
var id = '__getId()__'

配置数据：

data: {
	cubeName: 'game-cube-name',
	showId: 'XXXXXX',
	result: {
		msg: "success"
	},
	getId: function() {
		return this.showId
	}
}

输出：

var showId = 'XXXXXX'
var result = {"msg":"success"}
var msg = 'success'
var msg = 'game-cube-name|success'
var id = 'XXXXXX'