@tmsfe/tmskit 0.0.24 → 0.0.27

package/src/scripts/run/cloud/getClouds.js

@@ -0,0 +1,46 @@
+const { resolve, getAbsolutePath } = require('../../../utils/widgets');
+
+// 处理tms.config.cloudModules的兼容数据
+function getTmsCloudModules(tmsConfig) {
+  const { cloudModules } = tmsConfig;
+  if (Array.isArray(tmsConfig.cloudModules)) {
+    return {
+      all: [...tmsConfig.cloudModules],
+      include: [],
+    };
+  }
+  return cloudModules;
+}
+
+/**
+ * 获取需要监听的云函数
+ * @param {*} tmsConfig {}
+ * @param {*} cmdOptions eg：{clouds: 'aggrecarshop,car'}
+ * @returns
+ * [{ name: '', sourcePath: '', targetPath: ''}]
+ */
+function getCloudsOfListen(tmsConfig, cmdOptions) {
+  // 获取tmsconfig配置的云函数的配置项
+  const cloudModules = getTmsCloudModules(tmsConfig);
+
+  let includeClouds = cmdOptions?.cloud?.split(',') || cloudModules.include || [];
+
+  // 如果没有配置include, 默认使用所有的数据云函数列表
+  if (includeClouds.length === 0) {
+    includeClouds = cloudModules.all.map(item => item.name);
+  }
+
+  const result = [];
+  for (const item of cloudModules.all) {
+    if (includeClouds.includes(item.name)) {
+      result.push({
+        name: item.name,
+        sourcePath: `${getAbsolutePath(item.path)}`,
+        targetPath: resolve(tmsConfig.cloudDir, item.name),
+      });
+    }
+  }
+  return result;
+}
+
+module.exports = getCloudsOfListen;

package/src/scripts/run/cloud/install.js

@@ -0,0 +1,31 @@
+const shellJs = require('shelljs');
+const fs = require('fs');
+const { resolve, npmInstall } = require('../../../utils/widgets');
+const { ensureDirExist } = require('../../../utils/io');
+const { info } = require('../../../utils/log');
+
+/**
+ * npm install
+ * @param {array} clouds  [{name: '', sourcePath: '', targetPath: ''}]
+ */
+const runInstall = async (clouds, tmsConfig) => {
+  const promises = [];
+
+  for (const item of clouds) {
+    ensureDirExist(item.targetPath);
+    const packageFilePath = resolve(item.sourcePath, 'package.json');
+    if (fs.existsSync(packageFilePath)) {
+      shellJs.cp('-Rf', resolve(packageFilePath), item.targetPath);
+      promises.push(() => {
+        info(`云函数${item.name}: npm install`);
+        return npmInstall(item.targetPath, tmsConfig.npm);
+      });
+    }
+  };
+  await Promise.all(promises.map(item => item()));
+};
+
+
+module.exports = {
+  runInstall,
+};

package/src/scripts/run/cloud/link.js

@@ -0,0 +1,37 @@
+const fs = require('fs');
+const { info } = require('../../../utils/log');
+const { resolve } = require('../../../utils/widgets');
+const { ensureDirExist } = require('../../../utils/io');
+const { warn, succeed } = require('../../../utils/log');
+const getCloudsOfListen = require('./getClouds');
+const { handleError } = require('../../../core/handleError');
+const { checkCloudConfig } = require('./check');
+
+module.exports = async (tmsConfig, cmdOptions) => {
+  try {
+    ensureDirExist(resolve(tmsConfig.cloudDir));
+    checkCloudConfig(tmsConfig);
+
+    // 获取需要监听的云函数列表
+    const clouds = getCloudsOfListen(tmsConfig, cmdOptions);
+    // 打印启动云函数列表
+    info('当前启动云函数列表:', clouds.map(item => item.name).sort());
+
+
+    clouds.forEach((item) => {
+      if (!fs.existsSync(item.sourcePath)) {
+        warn(`云函数${item.sourcePath}不存在`);
+        return;
+      }
+      const stat = fs.lstatSync(item.targetPath);
+      if (!stat.isSymbolicLink()) {
+        fs.symlinkSync(item.sourcePath, item.targetPath);
+      }
+    });
+
+    succeed('云函数创建软链成功');
+  } catch (e) {
+    info('创建软链详细错误', e);
+    handleError(`创建软链错误: ${e}`, true);
+  }
+};

package/src/scripts/run/dev/index.js

@@ -7,7 +7,7 @@ const { info } = require('../../../utils/log');
 const { global } = require('../../../utils/global');
 const { MODULE_CODE_DIR, NODE_MODULES_DIR } = require('../../../config/constant');
 const report = require('../../../core/report');
-const { recommendVersion } = require('../../../core/recommendVersion');
+// const { recommendVersion } = require('../../../core/recommendVersion');
 
 
 // 用户编译分包时，需要将dist中其他分包(主包不能删除)的内容删除，否则其他分包的内容混入到主包(导致主包的体积超2M)
@@ -28,14 +28,14 @@ function delOtherPackages(tmsConfig, targetSubPackages) {
 }
 
 async function dev(tmsConfig, targetModules) {
-  const { noCache } = global.getData('cmd');
+  const { noCache } = global.getData('cmdOptions');
   if (noCache) {
     shelljs.rm('-rf', resolve(tmsConfig.outputDir));
     shelljs.rm('-rf', MODULE_CODE_DIR);
     shelljs.rm('-rf', NODE_MODULES_DIR);
   }
   // 推荐tmskit的版本
-  await recommendVersion();
+  // await recommendVersion();
 
   // 初始化操作
   const { subPackages, modules: newModules } = await init(tmsConfig, targetModules);
@@ -46,6 +46,7 @@ async function dev(tmsConfig, targetModules) {
       isDev: true,
       tmsConfig: filterField(tmsConfig, ['gitAccount']),
       modules: newModules,
+      cmdOptions: global.getData('cmdOptions'),
     });
     report('hooks:beforeCompile');
   };

package/src/scripts/run/index.js

@@ -3,7 +3,10 @@ const init = require('./init/index');
 const dev = require('./dev/index');
 const build = require('./build/index');
 const install = require('./install/index');
-const cloud = require('./cloud/index');
+const preview = require('./preview/index');
+const upload = require('./upload/index');
+const cloudLink = require('./cloud/link');
+const cloudDev = require('./cloud/dev');
 const { fail, info } = require('../../utils/log');
 const { global } = require('../../utils/global');
 const report = require('../../core/report');
@@ -14,10 +17,10 @@ const {
   getModulesByModuleNames,
 } = require('../../core/tmsMpconfig');
 
-const handleModuleArg = (cmd) => {
+const handleModuleArg = (cmdOptions) => {
   // 单模块或多模块开发-用户通过脚手架参数指定的模块
-  if (typeof cmd.module === 'string') {
-    return cmd.module.split(',');
+  if (typeof cmdOptions.module === 'string') {
+    return cmdOptions.module.split(',');
   }
   return [];
 };
@@ -45,22 +48,27 @@ const getSpecificModuleNames = (moduleArg, modules) => {
   return all.map(item => item.moduleName);
 };
 
-async function run(commandName, cmd) {
+async function run(commandName, cmdOptions) {
   // 用户本地的配置
   const tmsConfig = getTmsConfig();
   try {
     // 缓存数据
     global.setData({
-      cmd,
+      cmdOptions,
       tmsConfig,
     });
 
-    if (commandName === 'cloud') {
-      cloud(tmsConfig);
-      report('run:cloud', { appName: tmsConfig?.appName });
+    if (commandName === 'cloud-link') {
+      cloudLink(tmsConfig, cmdOptions);
+      report('run:cloud-link', { appName: tmsConfig?.appName });
       return;
     }
-    otherCommands(tmsConfig, commandName, cmd);
+    if (commandName === 'cloud-dev') {
+      cloudDev(tmsConfig, cmdOptions);
+      report('run:cloud-dev', { appName: tmsConfig?.appName });
+      return;
+    }
+    otherCommands(tmsConfig, commandName, cmdOptions);
   } catch (error) {
     const errMsg = typeof error === 'object' ? error.message : error;
     report('run', { errMsg, appName: tmsConfig?.appName });
@@ -70,10 +78,10 @@ async function run(commandName, cmd) {
   }
 }
 
-function otherCommands(tmsConfig, commandName, cmd) {
+function otherCommands(tmsConfig, commandName, cmdOptions) {
   // 处理module参数
   const specificModuleNames = getSpecificModuleNames(
-    handleModuleArg(cmd),
+    handleModuleArg(cmdOptions),
     tmsConfig.modules,
   );
 
@@ -89,21 +97,29 @@ function otherCommands(tmsConfig, commandName, cmd) {
   switch (commandName) {
     case 'init':
       init(tmsConfig, newModules);
-      report('run:init', { appName: tmsConfig?.appName });
+      report('run:init', { appName: tmsConfig.appName });
       return;
     case 'dev':
       global.setData('isDev', true);
       dev(tmsConfig, newModules);
-      report('run:dev', { appName: tmsConfig?.appName });
+      report('run:dev', { appName: tmsConfig.appName });
       return;
     case 'install':
       install(tmsConfig, subPackages, false);
-      report('run:install', { appName: tmsConfig?.appName });
+      report('run:install', { appName: tmsConfig.appName });
       return;
     case 'build':
       global.setData('isDev', false);
       build(tmsConfig, newModules);
-      report('run:build', { appName: tmsConfig?.appName });
+      report('run:build', { appName: tmsConfig.appName });
+      return;
+    case 'preview':
+      preview(tmsConfig, cmdOptions);
+      report('run:preview', { appName: tmsConfig.appName });
+      return;
+    case 'upload':
+      upload(tmsConfig, cmdOptions);
+      report('run:upload', { appName: tmsConfig.appName });
       return;
     default:
       return;

package/src/scripts/run/preview/index.js

@@ -0,0 +1,70 @@
+const mpCi = require('../../../core/mpCi');
+const fs = require('fs');
+const { resolve, createTask, getAbsolutePath, filterField } = require('../../../utils/widgets');
+const { handleError } = require('../../../core/handleError');
+const { info } = require('../../../utils/log');
+const { global } = require('../../../utils/global');
+const { getAllSize, outputInfo, getDesc } = require('./utils');
+const report = require('../../../core/report');
+
+
+const handleParams = (tmsConfig, cmdOptions) => {
+  const params = {
+    ...(tmsConfig.preview ? tmsConfig.preview : {}),
+    ...cmdOptions,
+  };
+  return {
+    ...params,
+    appId: params.appId || tmsConfig.appId,
+    projectPath: resolve(tmsConfig.outputDir),
+    privateKey: params.privateKey || tmsConfig.privateKey,
+    robot: params.robot || 30,
+    desc: params.desc || getDesc(params.desc),
+    qrcodeOutputDest: getAbsolutePath(params.qrcodeOutputDest || ''),
+  };
+};
+
+/**
+ * 预览
+ * @params {object} tmsConfig
+ * @param {object} cmdOptions {qrcodeFormat: 'base64', qrcodeOutputDest: './a.txt', robot: 2, infoOutput: './a.txt' }
+ */
+async function  preview(tmsConfig, cmdOptions) {
+  try {
+    const params = handleParams(tmsConfig, cmdOptions);
+    if (typeof tmsConfig?.hooks?.beforePreview === 'function') {
+      await tmsConfig?.hooks?.beforePreview({
+        tmsConfig: filterField(tmsConfig, ['gitAccount']),
+        cmdOptions: global.getData('cmdOptions'),
+        params,
+      });
+      report('hooks:beforePreview');
+    };
+    const previewRes = await createTask(
+      mpCi.previewMp,
+      '正在构建预览码',
+      '构建预览码完成',
+    )({
+      ...params,
+    });
+
+    const allSize = getAllSize(previewRes);
+    if (params.infoOutput) {
+      let qrcodeBase64 = '';
+      if (params.qrcodeFormat === 'base64' && fs.existsSync(params.qrcodeOutputDest)) {
+        qrcodeBase64 = fs.readFileSync(params.qrcodeOutputDest, 'utf8');
+      }
+      outputInfo(params.infoOutput, {
+        sourceCode: params.projectPath,
+        qrcodeBase64,
+        ...previewRes,
+      });
+    }
+    info('预览包大小:', `${allSize}k`);
+  } catch (e) {
+    console.log('详细错误:', e);
+    handleError(`预览错误: ${e.message}`, true);
+  }
+}
+
+module.exports = preview;

package/src/scripts/run/preview/utils.js

@@ -0,0 +1,43 @@
+const moment = require('moment');
+const path = require('path');
+const fs = require('fs');
+const {  getGitUser, getAbsolutePath } = require('../../../utils/widgets');
+const { ensureDirExist } = require('../../../utils/io');
+
+function getAllSize(data = {}) {
+  let allSize;
+  for (const item of data?.subPackageInfo) {
+    if (item.name === '__FULL__') {
+      allSize = item.size;
+      break;
+    }
+  }
+  return allSize;
+}
+
+const getDesc = (desc = '') => {
+  const user =  getGitUser();
+  const date = moment().format('YYYY-MM-DD HH:mm:ss');
+  return `构建描述：${desc}; 构建人: ${user}; 构建时间：${date}`;
+};
+
+const outputInfo = (infoOutput, data) => {
+  const outPath = getAbsolutePath(infoOutput);
+  const dir = path.dirname(outPath);
+  ensureDirExist(dir);
+  fs.writeFileSync(outPath, JSON.stringify(data, null, 2));
+};
+
+const getDetaultVersion = () => {
+  const version = moment().format('gggg,mm')
+    .split(',');
+  version.push('0');
+  return version.join('.');
+};
+
+module.exports = {
+  getAllSize,
+  getDesc,
+  outputInfo,
+  getDetaultVersion,
+};

package/src/scripts/run/upload/index.js

@@ -0,0 +1,65 @@
+const mpCi = require('../../../core/mpCi');
+const { resolve, createTask, filterField } = require('../../../utils/widgets');
+const { handleError } = require('../../../core/handleError');
+const { info } = require('../../../utils/log');
+const { global } = require('../../../utils/global');
+const { getAllSize, outputInfo, getDesc } = require('../preview/utils');
+const report = require('../../../core/report');
+
+const handleParams = (tmsConfig, cmdOptions) => {
+  const params = {
+    ...(tmsConfig.upload ? tmsConfig.upload : {}),
+    ...cmdOptions,
+  };
+
+  if (!params.version) {
+    throw new Error('请指定传入版本号 eg: tmskit run upload --version 2022.28.5');
+  }
+  return {
+    ...params,
+    appId: params.appId || tmsConfig.appId,
+    projectPath: resolve(tmsConfig.outputDir),
+    privateKey: params.privateKey || tmsConfig.privateKey,
+    robot: params.robot || 30,
+    desc: params.desc || getDesc(params.desc),
+  };
+};
+
+/**
+ * 上传
+ * @param {object} tmsConfig
+ * @param {object} cmdOptions {version: '2022.28.5', desc: '', robot: 2, infoOutput: './a.txt' }
+ */
+async function upload(tmsConfig, cmdOptions) {
+  try {
+    const params = handleParams(tmsConfig, cmdOptions);
+    if (typeof tmsConfig?.hooks?.beforeUpload === 'function') {
+      await tmsConfig?.hooks?.beforeUpload({
+        tmsConfig: filterField(tmsConfig, ['gitAccount']),
+        cmdOptions: global.getData('cmdOptions'),
+        params,
+      });
+      report('hooks:beforeUpload');
+    };
+    const uploadRes = await createTask(
+      mpCi.uploadMp,
+      '正在上传小程序代码',
+      '上传小程序代码完成',
+    )({
+      ...params,
+    });
+
+    const allSize = getAllSize(uploadRes);
+    if (params.infoOutput) {
+      outputInfo(params.infoOutput, {
+        sourceCode: params.projectPath,
+        ...uploadRes,
+      });
+    }
+    info(`上传包大小: ${allSize}k; 上传包版本: ${params.version}`);
+  } catch (e) {
+    console.log('详细错误:', e);
+    handleError(`上传错误: ${e.message}`, true);
+  }
+}
+module.exports = upload;

package/src/utils/widgets.js

@@ -231,6 +231,11 @@ function versionCompare(v1, v2) {
   return (arr1.length > arr2.length) ? 1 : -1;
 }
 
+function getGitUser() {
+  const res = shelljs.exec('git config user.name', { async: false, silent: true });
+  return res.stdout;
+}
+
 module.exports = {
   resolve,
   isObject,
@@ -247,4 +252,5 @@ module.exports = {
   getAbsolutePath,
   getNpmRegistry,
   versionCompare,
+  getGitUser,
 };

package/src/core/cache.js

@@ -1,36 +0,0 @@
-const fs = require('fs');
-const path = require('path');
-const { CACHE_FILE, CACHE_DIR } = require('../config/constant');
-const { ensureDirExist } = require('../utils/io');
-
-function getCache(projectDir, type) {
-  const filePath = `${CACHE_DIR}/${CACHE_FILE}`;
-  if (!fs.existsSync(filePath)) {
-    return null;
-  }
-  const content = require(filePath);
-  return content?.[projectDir]?.[type];
-}
-
-
-function setCache(projectDir, type = 'miniprogram_npm', data) {
-  const filePath = `${CACHE_DIR}/${CACHE_FILE}`;
-  if (!fs.existsSync(filePath)) {
-    const dir = path.dirname(filePath);
-    ensureDirExist(dir);
-    fs.writeFileSync(filePath, '{}');
-  }
-  const content = require(filePath);
-  if (!content[projectDir]) {
-    content[projectDir] = {};
-  }
-  content[projectDir] = {
-    [type]: data,
-  };
-  fs.writeFileSync(filePath, JSON.stringify(content, null, 2));
-}
-
-module.exports = {
-  setCache,
-  getCache,
-};

package/src/core/symbolicLink.js

@@ -1,33 +0,0 @@
-const fs = require('fs');
-const { resolve } = require('../utils/widgets');
-const { ensureDirExist } = require('../utils/io');
-const { warn, succeed } = require('../utils/log');
-
-/**
- * 根据相关配置创建软链接
- * @param { object } tmsConfig
- */
-const symLink = (tmsConfig) => {
-  ensureDirExist(resolve(tmsConfig.cloudDir));
-  if (tmsConfig.cloudModules) {
-    tmsConfig.cloudModules.forEach((item) => {
-      const sourcePath = resolve(item.path);
-      const targetPath = resolve(tmsConfig.cloudDir, item.name);
-
-      if (!fs.existsSync(sourcePath)) {
-        warn(`云函数${sourcePath}不存在`);
-        return;
-      }
-      if (!fs.existsSync(targetPath)) {
-        fs.symlinkSync(sourcePath, targetPath);
-      }
-    });
-    succeed('云函数创建软链成功');
-  } else {
-    warn('你没有在tms.config.js的cloudModules注册云函数');
-  }
-};
-
-module.exports = {
-  symLink,
-};

package/src/scripts/run/cloud/index.js

@@ -1,10 +0,0 @@
-const { symLink } = require('../../../core/symbolicLink');
-const { handleError } = require('../../../core/handleError');
-
-module.exports = async (tmsConfig) => {
-  try {
-    await symLink(tmsConfig);
-  } catch (e) {
-    handleError(`创建软链错误: ${e}`);
-  }
-};