@opentapd/tplugin-cli 0.49.0 → 0.50.0

package/cli.js

@@ -94,6 +94,11 @@ program.command('resources')
   .description('添加扩展模块模板')
   .action(actionRunner(() => require('./lib/resources')()));
 
+// modules 添加新的开放能力扩展
+program.command('modules')
+  .description('添加开放能力扩展demo')
+  .action(actionRunner(() => require('./lib/modules')()));    
+
 if (tpluginConf.tapd.pluginEnv !== 'cloud') {
   // workspace 创建个人专属开发项目
   program.command('workspace')

package/lib/modules.js

@@ -0,0 +1,224 @@
+/**
+ * Copyright 2021 Tencent Inc. All rights reserved.
+ * Author: raferzeng@tencent.com
+ *
+ * The implementation of CLI: resources
+ */
+
+const chalk = require('chalk');
+const fs = require('fs-extra');
+const yaml = require('js-yaml');
+const spinner = require('../util/spinner');
+const tapdsdk = require('../util/tapd');
+const inquirer = require('inquirer');
+const checkPluginYaml = require('../util/checkPluginYaml');
+const _ = require('lodash');
+const rimraf = require('rimraf');
+const { exec } = require('child_process');
+const path = require('path');
+const { downloadAndUnzip } = require('../util/tools');
+const tpluginConf = require('../config');
+const util = require('util');
+const execPromised = util.promisify(exec);
+const asyncExec = async (...args) => {
+  const { stdout, stderr } = await execPromised(...args);
+  if (stderr) {
+    throw new Error(stderr);
+  }
+
+  return stdout;
+};
+
+// modules命令实现
+module.exports = async () => {
+  // 检查plugin.yaml 文件
+  checkPluginYaml();
+
+  const yamlPath = `${process.cwd()}/plugin.yaml`;
+
+  // 选择要添加的 开放能力扩展
+  const moduleExt = await getModuleExt();
+
+  const docObj = yaml.load(fs.readFileSync(yamlPath, 'utf8')); // 现在的配置
+  try {
+    // 合并并过滤重复配置
+    const pluginConfigs = filterPluginConfigs(docObj, moduleExt);
+
+    // plugin.yaml中写入扩展点配置
+    docObj.app = pluginConfigs;
+    fs.writeFileSync(yamlPath, yaml.dump(docObj));
+    spinner.succeed('plugin.yaml写入成功');
+  } catch (err) {
+    spinner.fail(`plugin.yaml写入失败. Err : ${err}`);
+  }
+
+  // 拉取并添加开放能力扩展模版文件
+  await createModuleExtFromZip(moduleExt);
+};
+
+/**
+ * getModuleExt() 加载并选择添加的开放能力扩展配置
+ * @returns {Object}
+ */
+async function getModuleExt() {
+  spinner.start('加载开放能力...');
+  // 加载开放能力
+  try {
+    const moduleExtOpts = await getModuleExtOpts();
+
+    if (!moduleExtOpts.length) {
+      spinner.fail(chalk.red('加载开放能力失败'));
+      return;
+    }
+
+    spinner.stop();
+    const moduleExtList = moduleExtOpts.map((item) => {
+      const { key , name } = item;
+      return {
+        name: `${key} (${name})`,
+        value: item,
+      };
+    });
+
+    const required = function (value) {
+      return value.length ? true : '请按空格键选择开放能力';
+    };
+
+    // 选择需要添加的开放能力
+    return await inquirer.prompt([{
+      type: 'checkbox',
+      name: 'extensions',
+      message: '请选择要扩展的开放能力:',
+      choices: moduleExtList,
+      loop: false,
+      validate: required,
+    }]);
+
+  } catch (err) {
+    spinner.fail(chalk.red(`加载开放能力失败 ${err}`));
+    return;
+  }  
+}
+
+/**
+ * getEntranceOpts() 加载开放能力扩展
+ */
+async function getModuleExtOpts() {
+  const { data } = await tapdsdk.request({ url: '/open_user_app/module_extensions', method: 'GET' });
+  return (data.data || []);
+}
+
+/**
+ * filterPluginConfigs() 合并并过滤重复配置
+ * @param {Object} docObj - 已有配置
+ * @param {Object} moduleExt - 新添加的配置
+ * @returns {Object[]|boolean}
+ */
+function filterPluginConfigs(docObj, moduleExt) {
+  let pluginConfigs = docObj.app || [];
+
+  // 合并添加的配置信息
+  moduleExt.extensions.forEach(exetension => {
+    // 防重
+    const currentExetension = _.get(pluginConfigs, exetension.path, []);
+    // 检查对象的值中是否包含unique_key
+    const hasUniqueKey = _.some(currentExetension, (item) => {
+      if (exetension?.key !== 'webhook') {
+        return item.code === exetension.unique_key;
+    } else {
+        return item.handler === exetension.unique_key;
+    }
+    });
+
+    if(!hasUniqueKey){
+      pluginConfigs = _.mergeWith({}, pluginConfigs, exetension.demo, customizer);
+    }else{
+      spinner.fail(`该扩展开放能力已经存在 : ${exetension.name}`);
+    }
+  });
+
+  return pluginConfigs;
+}
+
+function customizer(objValue, srcValue) {
+  // 如果是数组，则合并数组
+  if (_.isArray(objValue)) {
+      return objValue.concat(srcValue);
+  }
+  // 如果不是数组，继续使用默认的 merge 行为
+}
+
+function createModuleExtDemo(moduleExt) {
+  const frame = 'ui-nodejs-vue';
+  const demoPath = path.join(process.cwd(), 'demo');
+  const basePath = path.join(demoPath, frame);
+
+  try {
+    moduleExt.extensions.forEach(exetension => {
+        const tmlPath = path.join(demoPath, exetension.demoTmpl);
+        exetension.demoTmplFile.forEach(fileDir => {
+          const sourceDirPath = path.join(tmlPath, fileDir);
+          const currentDirPath = path.join(process.cwd(), fileDir);
+          // 复制模板文件到插件仓库目录中
+          fs.copySync(`${sourceDirPath}`, currentDirPath);
+        });
+        spinner.succeed(`扩展开放能力: ${exetension.name} 模板创建成功`);
+      });
+    fs.copySync(path.join(basePath, 'package.json'), path.join(process.cwd(), 'package.json'));
+    fs.copySync(path.join(basePath, 'utils.js'), path.join(process.cwd(), 'utils.js'));
+    fs.copySync(path.join(basePath, 'webpack.config.js'), path.join(process.cwd(), 'webpack.config.js'));      
+  } catch (err) {
+    rimraf(demoPath, () => {});
+    spinner.fail(`扩展开放能力模板创建失败. Err : ${err}`);
+  }
+  rimraf(demoPath, () => {});
+}
+
+async function createModuleExtFromZip(moduleExt) {
+  const repoRes = await getTmpRepoUrl({ code: 'demo' });
+  if (!repoRes || !repoRes.status) {
+    spinner.fail('获取Demo代码失败.');
+    return ;
+  }
+
+  spinner.start('开始生成 Demo 代码');
+  await downloadAndUnzip(repoRes.data.download_url);
+  spinner.start('开始模板定制工作 🔥🔥🔥');
+  await demoDecorateJob();
+
+  spinner.succeed('Demo 代码生成成功');
+  rimraf('demo.zip', () => {});
+
+  createModuleExtDemo(moduleExt);
+}
+
+/**
+ *
+ * @description 替换demo中的一些特定值，如 @tencent 的包名
+ */
+async function demoDecorateJob() {
+  const PLUGIN_ENV = tpluginConf.tapd.pluginEnv;
+
+  if (
+    PLUGIN_ENV !== 'oa'
+  ) {
+    const NPM_SCOPED_NAME = {
+      cloud: '@opentapd',
+      ex: '@tapd',
+    };
+
+    const npmScopedName = NPM_SCOPED_NAME[PLUGIN_ENV];
+
+    await asyncExec(`node demo/scripts/replace-tencent-in-package-json/sh.js demo/ui-nodejs-vue/package.json ${npmScopedName}`);
+    await asyncExec(`node demo/scripts/replace-package-name/sh.js ${path.join(process.env.PWD, `demo/ui-nodejs-vue`)} ${npmScopedName}`);
+  }
+}
+
+/**
+ * getTmpRepoUrl(): 获取仓库当前代码制品code.zip的临时下载链接
+ * @return array data
+ */
+async function getTmpRepoUrl(params) {
+  const { data } = await tapdsdk.request({ url: '/open_user_app/get_tmp_repo_url', method: 'POST', params });
+  return data;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opentapd/tplugin-cli",
-  "version": "0.49.0",
+  "version": "0.50.0",
   "description": "tplugin-cli",
   "bin": {
     "tplugin-cli": "index.js"
@@ -78,5 +78,5 @@
     "node": ">=14.13.0"
   },
   "main": "index.js",
-  "gitHead": "261428742065feb6a1594ff9111b95c86109a434"
+  "gitHead": "0f64809cfd742799f1441b626ad4b85a7cdf8eb4"
 }