@opentapd/tplugin-cli 0.19.0

package/Readme.cloud.md

@@ -0,0 +1,13 @@
+# TAPD 托管命令行
+
+
+```bash
+tplugin-cli logout 
+
+tplugin-cli login
+
+```
+
+[快速入门](https://open.tapd.cn/document/plugin-doc/introduction/getting-started.html)
+
+### 欢迎反馈

package/Readme.ex.md

@@ -0,0 +1,13 @@
+# TAPD 托管命令行
+
+
+```bash
+tplugin-cli logout 
+
+tplugin-cli login
+
+```
+
+[快速入门](https://o.tapd.tencent.com/document/plugin-doc/introduction/getting-started.html)
+
+### 欢迎反馈

package/Readme.oa.md

@@ -0,0 +1,23 @@
+# TAPD 托管命令行
+
+
+## IDC 网络的使用
+
+### 怎看自己是不是IDC网络
+
+查看这个[链接](https://iwiki.woa.com/tencent/static/iwiki-editor-pro/dist/preview.html?space=&page=1227785302&id=131410&name=6997554869969258912(1).MP4&size=1160018&language=zh)
+
+### 如果是 IDC 网路怎么办
+
+```bash
+export TPLUGIN_ENV='idc'
+
+tplugin-cli logout 
+
+tplugin-cli login
+
+```
+
+[快速入门](https://o.tapd.woa.com/document/plugin-doc/introduction/getting-started.html)
+
+### 欢迎反馈

package/cli.js

@@ -0,0 +1,109 @@
+#!/usr/bin/env node
+'use strict';
+
+const { program } = require('commander');
+const chalk = require('chalk');
+const packageJson = require('./package.json');
+const enhanceErrorMessages = require('./util/enhanceErrorMessages');
+const errorHandler = require('./util/errorHandler');
+const tpluginConf = require('./config');
+
+process.on('uncaughtException', errorHandler);
+process.on('unhandledRejection', (error) => {
+  errorHandler(error, { exit: false });
+});
+/**
+ * 获取执行某个命令的Runner
+ * @description 执行fn函数，并catch errorhandler
+ */
+function actionRunner(fn) {
+  return process.env.NODE_ENV === 'test'
+    ? fn
+    : (...args) => fn(...args).catch(errorHandler);
+}
+
+// version 获取CLI版本
+program.version(packageJson.version)
+  .usage('<command> [options]');
+
+// create <code> 创建插件
+program.command('create <code>')
+  .description('通过CLI创建一个TAPD插件')
+  .option('-n, --name <name>', '插件名字')
+  .action(actionRunner((code, opts) => require('./lib/create')(code, opts)));
+
+// login 登录
+program.command('login')
+  .description('用户登录，用于登录使用 cli')
+  .option('--login-by-tgit', '使用工蜂登录态登录')
+  .action(actionRunner(opts => require('./lib/login')(opts)))
+  .allowUnknownOption();
+
+// logout 退出登录
+program.command('logout')
+  .description('退出当前用户登录用户')
+  .action(actionRunner(() => require('./lib/logout')()));
+
+// lint 检查插件配置
+program.command('lint')
+  .description('插件检查，检查当前插件配置是否正确')
+  .action(actionRunner(async () => {
+    await require('./lib/lint')();
+    console.log('');
+  }));
+
+// serve 启动本地插件调试
+program.command('serve')
+  .description('用于运行和调试本地插件代码，可以选择一个项目作为调试项目，启动后，本地插件代码将直接于目标项目生效')
+  .action(actionRunner(() => require('./lib/serve')()));
+
+// install 安装指令，安装插件到某个项目
+program.command('install')
+  .description('安装测试项目')
+  .action(actionRunner(async () => {
+    await require('./lib/install')();
+    console.log('');
+  }));
+
+// init 初始化插件
+program.command('init')
+  .description('初始化插件配置信息，用于本地调试鉴权')
+  .action(actionRunner(() => require('./lib/init')()));
+
+// deploy 部署插件
+program.command('deploy')
+  .description('部署应用')
+  .action(actionRunner(() => require('./lib/deploy')()));
+
+// encrtypt 加密敏感变量
+program.command('encrypt <value>')
+  .description('加密敏感变量')
+  .action(actionRunner(value => require('./lib/encrypt')(value)));
+
+// resource 添加新的UI扩展模块
+program.command('resources')
+  .description('添加扩展模块模板')
+  .action(actionRunner(() => require('./lib/resources')()));
+
+// workspace 创建个人专属开发项目
+if (tpluginConf.tapd.pluginEnv !== 'cloud') {
+  program.command('workspace')
+    .description('创建TAPD开发项目')
+    .action(actionRunner(() => require('./lib/workspace')()));
+}
+
+// repo 手动拉取最新部署的代码包指令
+if (tpluginConf.tapd.pluginEnv !== 'oa') {
+  program.command('repo <code>')
+    .description('手动拉取最新部署的代码包指令')
+    .action(actionRunner(code => require('./lib/repo')(code)));
+}
+
+enhanceErrorMessages('missingArgument', argName => `Missing required argument ${chalk.yellow(`<${argName}>`)}.`);
+
+enhanceErrorMessages('unknownOption', optionName => `Unknown option ${chalk.yellow(optionName)}.`);
+
+enhanceErrorMessages('optionMissingArgument', (option, flag) => `Missing required argument for option ${chalk.yellow(option.flags)}${
+  flag ? `, got ${chalk.yellow(flag)}` : ''}`);
+
+module.exports = program;

package/config.json

@@ -0,0 +1,12 @@
+{
+    "tapd": {
+        "openHost": "https://open.tapd.cn",
+        "tapdHost": "https://tapd.cn",
+        "websocketHost": "wss://proxifer.tapd.cn/proxy",
+        "apiHost": "https://api.tapd.cn",
+        "upgradeWebsocketHost": "wss://upgrader.tapd.cn",
+        "pluginEnv": "cloud"
+    },
+    "npm": {},
+    "pip": {}
+}

package/index.js

@@ -0,0 +1,5 @@
+#!/usr/bin/env node
+'use strict';
+require('./util/checkNodeVersion');
+const program = require('./cli');
+program.parse(process.argv);

package/lib/create.js

@@ -0,0 +1,314 @@
+/**
+ * Copyright 2021 Tencent Inc. All rights reserved.
+ * Author: terrysxu@tencent.com
+ * Author: raferzeng@tencent.com
+ *
+ * The implementation of CLI: create <code>
+ */
+const inquirer = require('inquirer');
+const chalk = require('chalk');
+const { chdir } = require('process');
+const { exec } = require('child_process');
+const tapdsdk = require('../util/tapd');
+const Session = require('../util/session');
+const spinner = require('../util/spinner');
+const tpluginConf = require('../config');
+const json5 = require('json5');
+const _ = require('lodash');
+const fs = require('fs-extra');
+const path = require('path');
+const { downloadAndUnzip } = require('../util/tools');
+const { promisify } = require('util');
+
+/**
+ * @description 根据code和option配置，创建插件
+ * @param code 唯一标识
+ * @param options 选择的创建配置
+ */
+module.exports = async (code, options) => {
+  // 初始化Session
+  const session = new Session();
+
+  // 校验登录态
+  session.checkAuth();
+
+  await checkAppParams({
+    code,
+    name: options.name || code,
+  });
+
+  spinner.start('加载应用模板...');
+  // 加载创建模板
+  const createTmpl = await getCreateTmpl();
+
+  if (!createTmpl || !createTmpl.status) {
+    spinner.fail(chalk.red('获取模板失败'));
+    return;
+  }
+
+  spinner.stop();
+
+  const tmpList = Object.entries(createTmpl.data)
+    .map(([key, value]) => ({
+      name: `${key} (${value.desc})`,
+      value: key,
+    }));
+
+  // 选择创建模板
+  const selectedTmpl = await inquirer.prompt([{
+    type: 'list',
+    name: 'template',
+    message: '请选择你要创建的模板:',
+    choices: tmpList,
+  }]);
+
+  // 支持的挂载点
+  const supportEntrances = _.get(createTmpl, `data.${selectedTmpl.template}.support_entrances`, false);
+  const entranceConfigs  = supportEntrances ? await selectEntrances() : {};
+
+  const params = {
+    code,
+    name: options.name || code,
+    template: selectedTmpl.template,
+    ...entranceConfigs,
+  };
+
+  spinner.start('稍等片刻，正在创建...');
+  // 调起创建插件
+  const res = await create(params);
+
+  if (!res || !res.status) {
+    spinner.fail('创建插件失败');
+    return;
+  }
+
+  if (res && res.status) {
+    spinner.stop();
+    // 创建完成后，拉取代码
+    await cloneRepo(res, code);
+  }
+};
+
+/**
+ * checkAppParams(): 检查插件参数
+ * @return array data
+ */
+async function checkAppParams(params) {
+  const { data } = await tapdsdk.request({ url: '/open_user_app/check_app_params', method: 'POST', params });
+  return data;
+}
+
+/**
+ * getCreateTmpl(): 获取创建模板列表
+ * @return array data
+ */
+async function getCreateTmpl() {
+  const { data } = await tapdsdk.request({ url: '/open_user_app/templates', method: 'POST' });
+  return data;
+}
+
+/**
+ * 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;
+}
+
+/**
+ * getEntranceOpts(): 获取可选过载点列表
+ * @return {_key: string, _tags: string, _name: string, ...others: any }[]
+ */
+async function getEntranceOpts() {
+  const { data } = await tapdsdk.request({ url: '/open_user_app/entrance_templates', method: 'POST' });
+
+  return (data.data || []).map((entrance) => {
+    // json 解析
+    const demo = json5.parse(entrance.demo);
+    delete demo.url;
+    return {
+      ...demo,
+      _key: entrance.identifier,
+      _tags: entrance.tags,
+      _name: entrance.name,
+    };
+  });
+}
+
+// create(params)： 创建插件请求
+async function create(params) {
+  const { data } = await tapdsdk.request({ url: '/open_user_app/create_app', method: 'POST', params });
+  return data;
+}
+
+/**
+ * @description clone 创建的插件代码库
+ * @param res 插件创建基本信息
+ * @param code  插件标识code
+ */
+async function cloneRepo(res, code) {
+  if (tpluginConf.tapd.pluginEnv === 'oa') {
+    const repoList = [
+      {
+        name: res.data.git_repo_url,
+        value: res.data.git_repo_url,
+      },
+      {
+        name: res.data.git_ssh_url,
+        value: res.data.git_ssh_url,
+      },
+      {
+        name: '先缓缓, 稍后手动clone仓库',
+        value: 'later',
+      },
+    ];
+      // 选择是否拉取仓库
+    const gitRepo = await inquirer.prompt([{
+      type: 'list',
+      name: 'repo',
+      message: '应用创建成功，并自动为您生成了代码库，请clone下来进行开发: ',
+      choices: repoList,
+    }]);
+
+    if (gitRepo.repo === 'later') {
+      spinner.succeed(`应用创建成功, 仓库地址：${res.data.git_repo_url}, ${res.data.git_ssh_url}`);
+      return;
+    }
+
+    const promiseExec = promisify(exec);
+
+    await promiseExec(`git clone ${gitRepo.repo}`);
+    spinner.succeed('代码拉取成功');
+    chdir(code);
+    const packageJsonPath = path.join(process.cwd(), 'package.json');
+    if (fs.pathExistsSync(packageJsonPath)) {
+      // 设置 npm 源到 tencent 源
+      if (tpluginConf.tapd.pluginEnv === 'oa') {
+        await promiseExec(`npm config set registry ${tpluginConf.npm.registry}`);
+      }
+      spinner.start('稍等片刻，正在安装依赖...');
+      await promiseExec('npm install');
+      spinner.succeed('依赖安装成功');
+    }
+  // ex逻辑
+  } else {
+    try {
+      const params = {
+        code,
+      };
+
+      // 获取临时下载仓库链接
+      const repoRes = await getTmpRepoUrl(params);
+
+      if (!repoRes || !repoRes.status) {
+        spinner.fail(`应用创建成功，但是获取临时下载仓库链接失败，请手动执行tplugin repo ${code}下载当前${code}插件代码`);
+        return;
+      }
+
+      const repoList = [
+        {
+          name: `自动下载${code}仓库`,
+          value: 'now',
+        },
+        {
+          name: `先缓缓, 稍后手动下载${code}仓库`,
+          value: 'later',
+        },
+      ];
+      // 选择是否下载仓库
+      const gitRepo = await inquirer.prompt([{
+        type: 'list',
+        name: 'repo',
+        message: `应用创建成功，并自动为您生成了${code}代码库，请下载下来进行开发: `,
+        choices: repoList,
+      }]);
+
+      if (gitRepo.repo === 'later') {
+        spinner.succeed(`应用创建成功,请手动执行tplugin repo ${code}下载当前${code}插件代码`);
+        return;
+      }
+      await downloadAndUnzip(repoRes.data.download_url);
+    } catch (e) {
+      e.title = `下载失败，请手动执行tplugin repo ${code}下载当前${code}插件代码`;
+      throw e;
+    }
+  }
+}
+
+// selectEntrances(): 选择模板
+async function selectEntrances() {
+  spinner.start('加载应用模板...');
+  const entranceOpts = await getEntranceOpts();
+
+  if (!entranceOpts.length) {
+    spinner.fail(chalk.red('获取扩展模块模板失败'));
+    return;
+  }
+
+  spinner.stop();
+
+  // 数据格式转化
+  const entranceList = entranceOpts.map((item) => {
+    const { _key, _name } = item;
+    return {
+      name: `${_key} (${_name})`,
+      value: item,
+    };
+  });
+
+  const required = function (value) {
+    return value.length ? true : '请按空格键选择扩展模块';
+  };
+
+  // 使用空格选择扩展模块
+  const selectedTmpl = await inquirer.prompt([{
+    type: 'checkbox',
+    name: 'entrance',
+    message: '请选择扩展模块:',
+    choices: entranceList,
+    loop: false,
+    validate: required,
+  }]);
+
+  const entrance = selectedTmpl.entrance.filter(item => !item._tags);
+  const objectEntrances = selectedTmpl.entrance.filter(item => item._tags);
+  let tagsQue = [];
+
+  // 针对业务挂载点，选择扩展的业务对象，如：需求、缺陷、迭代、任务
+  if (objectEntrances.length) {
+    const requiredObj = function (value) {
+      return value.length ? true : '请按空格键选择业务对象';
+    };
+    tagsQue = objectEntrances.map(item => ({
+      type: 'checkbox',
+      name: item._key,
+      message: `请选择 ${item._key} 作用的业务对象:`,
+      choices: item._tags.split(','),
+      validate: requiredObj,
+    }));
+  }
+
+  const entranceTmpl = await inquirer.prompt(tagsQue);
+
+  // 格式化挂载点配置
+  const formmatedObjectEntrances = objectEntrances.reduce((pre, objEntrance) => {
+    const tmp =  entranceTmpl[objEntrance._key];
+    return pre.concat(tmp.map(tag => ({
+      ...objEntrance,
+      tag,
+    })));
+  }, []);
+
+  const resourceConfigs = entrance.concat(formmatedObjectEntrances);
+
+  // 组装返回数据
+  return {
+    entrances: resourceConfigs.map(entrance => (entrance._tags ? `${entrance._key}_${entrance.tag}` : entrance._key)),
+    resources_configs: JSON.stringify(resourceConfigs.map(entrance => ({
+      ..._.omit(entrance, ['_key', '_tags', '_name']),
+      key: entrance._key,
+      path: entrance._tags ? `pages/${entrance._key}_${entrance.tag}` : `pages/${entrance._key}`,
+    }))),
+  };
+}