@tmsfe/tmskit 0.0.21 → 0.0.24-beta.0

package/src/scripts/create/index.js

@@ -15,6 +15,7 @@ const { fail, succeed, info } = require('../../utils/log');
 const generator = require('./generator');
 const request = require('request');
 const unzip = require('unzipper');
+const report = require('../../core/report');
 
 /**
  * 如果该目录下面存在文件，换个名字
@@ -71,6 +72,7 @@ async function create(projectName) {
   const cwd = process.cwd();
   const targetDir = path.resolve(cwd, projectName);
   const { projectType } = await inquirer.prompt(CREATE_TEMPLATE_QUESTION);
+  report('create-start', { projectType });
 
   // 创建项目目录
   await createProjectDir(targetDir);
@@ -101,7 +103,7 @@ async function create(projectName) {
       }
       shelljs.rm('-rf', resolve(projectName, TEMPLATE_TKIT_DIR));
     }
-
+    report('create-success', { projectType });
     succeed('项目创建完成.');
   })
     .catch((err) => {

package/src/scripts/extend-cmd/index.js

@@ -0,0 +1,74 @@
+
+const fs = require('fs');
+const path = require('path');
+const shellJs = require('shelljs');
+const { ensureDirExist } = require('../../utils/io');
+const { EXTEND_CMD } = require('../../config/constant');
+const { createTask } = require('../../utils/widgets');
+const { info, fail } = require('../../utils/log');
+
+/**
+ * 下载扩展命令的npm包
+ * @param {string} npmName npm包名
+ * @param {object} cmd  {registry: 'http://mirrors.tencent.com/npm/'} 用户输入执行install-cmd的参数
+ */
+async function installCmd(npmName, cmd) {
+  try {
+    const cmdPackageJson = `${EXTEND_CMD}/package.json`;
+    if (!fs.existsSync(cmdPackageJson)) {
+      ensureDirExist(EXTEND_CMD);
+      fs.writeFileSync(cmdPackageJson, JSON.stringify({ dependencies: {} }, null, 2));
+    }
+    shellJs.cd(EXTEND_CMD);
+    await createTask(npmName => new Promise((resolve, reject) => {
+      const registry = cmd.registry ? `--registry=${cmd.registry}` : '';
+      shellJs.exec(
+        `npm install --save ${npmName} ${registry}`,
+        { cwd: EXTEND_CMD, silent: true },
+        (code, stdout, stderr) => {
+          if (code !== 0) {
+            reject(stderr);
+          }
+          resolve();
+        },
+      );
+    }), `开始下载${npmName}`, `下载${npmName}完成`)(npmName);
+  } catch (e) {
+    fail('构建出现错误:');
+    info(e);
+    process.exit(1);
+  }
+}
+
+
+/**
+ * 加载扩展命令的npm包
+ * @returns
+ */
+function loadExtendCmd() {
+  const cmdPackageJson = `${EXTEND_CMD}/package.json`;
+  const cmdNpmDir = `${EXTEND_CMD}/node_modules`;
+  if (fs.existsSync(cmdPackageJson)) {
+    const content = fs.readFileSync(cmdPackageJson, 'utf8');
+    const json = JSON.parse(content);
+    const deps = json.dependencies || {};
+
+    const cmdConfigs = [];
+    Object.keys(deps).forEach((name) => {
+      // 检索cmd的npm包
+      if (!/^tmskit-cmd-|^@[^/]+\/tmskit-cmd-/.test(name)) return false;
+      const cmdConfig = path.join(cmdNpmDir, name, 'tms.config.js');
+      if (fs.existsSync(cmdConfig)) {
+        cmdConfigs.push(cmdConfig);
+      }
+    });
+    return cmdConfigs;
+  }
+  return [];
+}
+
+
+module.exports = {
+  installCmd,
+  loadExtendCmd,
+};

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

@@ -1,20 +1,27 @@
 const shelljs = require('shelljs');
 const { resolve, filterField } = require('../../../utils/widgets');
 const init = require('../init/index');
+const { info } = require('../../../utils/log');
 const compileBuild = require('../../../compile/build');
+const report = require('../../../core/report');
+const { global } = require('../../../utils/global');
 
 async function build(tmsConfig, targetModules) {
   // 开始构建前，清理输出目录
   await shelljs.rm('-rf', resolve(tmsConfig.outputDir));
 
   const { modules: newModules } = await init(tmsConfig, targetModules);
+  info('当前build有效模块', newModules.map(item => item.moduleName).sort());
 
   const isDev = false;
-  if (typeof tmsConfig?.hooks?.beforeCompile === 'function') {
-    await tmsConfig?.hooks?.beforeCompile({
+  if (typeof tmsConfig?.hooks?.beforeFirstCompile === 'function') {
+    await tmsConfig?.hooks?.beforeFirstCompile({
       isDev,
       tmsConfig: filterField(tmsConfig, ['gitAccount']),
-      modules: newModules });
+      modules: newModules,
+      cmdOptions: global.getData('cmdOptions'),
+    });
+    report('hooks:beforeCompile');
   };
   compileBuild(tmsConfig, newModules, isDev);
 }

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

@@ -5,6 +5,6 @@ module.exports = async (tmsConfig) => {
   try {
     await symLink(tmsConfig);
   } catch (e) {
-    handleError(`创建软链错误: ${e}`);
+    handleError(`创建软链错误: ${e}`, true);
   }
 };

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

@@ -5,7 +5,9 @@ const init = require('../init/index');
 const { getModulesByMergeDepModules, getSubPackages } = require('../../../core/tmsMpconfig');
 const { info } = require('../../../utils/log');
 const { global } = require('../../../utils/global');
-const { CACHE_DIR } = require('../../../config/constant');
+const { MODULE_CODE_DIR, NODE_MODULES_DIR } = require('../../../config/constant');
+const report = require('../../../core/report');
+const { recommendVersion } = require('../../../core/recommendVersion');
 
 
 // 用户编译分包时，需要将dist中其他分包(主包不能删除)的内容删除，否则其他分包的内容混入到主包(导致主包的体积超2M)
@@ -26,22 +28,27 @@ 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', CACHE_DIR);
+    shelljs.rm('-rf', MODULE_CODE_DIR);
+    shelljs.rm('-rf', NODE_MODULES_DIR);
   }
+  // 推荐tmskit的版本
+  await recommendVersion();
 
   // 初始化操作
   const { subPackages, modules: newModules } = await init(tmsConfig, targetModules);
 
   info('当前dev启动的有效模块', newModules.map(item => item.moduleName).sort());
-  if (typeof tmsConfig?.hooks?.beforeCompile === 'function') {
-    await tmsConfig?.hooks?.beforeCompile({
+  if (typeof tmsConfig?.hooks?.beforeFirstCompile === 'function') {
+    await tmsConfig?.hooks?.beforeFirstCompile({
       isDev: true,
       tmsConfig: filterField(tmsConfig, ['gitAccount']),
       modules: newModules,
+      cmdOptions: global.getData('cmdOptions'),
     });
+    report('hooks:beforeCompile');
   };
   delOtherPackages(tmsConfig, subPackages);
   compileDev(tmsConfig, newModules, true);

package/src/scripts/run/index.js

@@ -3,9 +3,12 @@ const init = require('./init/index');
 const dev = require('./dev/index');
 const build = require('./build/index');
 const install = require('./install/index');
+const preview = require('./preview/index');
+const upload = require('./upload/index');
 const cloud = require('./cloud/index');
 const { fail, info } = require('../../utils/log');
 const { global } = require('../../utils/global');
+const report = require('../../core/report');
 const {
   getTmsConfig,
   getModulesByMergeDepModules,
@@ -13,10 +16,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 [];
 };
@@ -44,34 +47,35 @@ const getSpecificModuleNames = (moduleArg, modules) => {
   return all.map(item => item.moduleName);
 };
 
-async function run(commandName, cmd) {
+async function run(commandName, cmdOptions) {
+  // 用户本地的配置
+  const tmsConfig = getTmsConfig();
   try {
-    // 用户本地的配置
-    const tmsConfig = getTmsConfig();
-
     // 缓存数据
     global.setData({
-      cmd,
+      cmdOptions,
       tmsConfig,
     });
 
     if (commandName === 'cloud') {
       cloud(tmsConfig);
+      report('run:cloud', { appName: tmsConfig?.appName });
       return;
     }
-    otherCommands(tmsConfig, commandName, cmd);
+    otherCommands(tmsConfig, commandName, cmdOptions);
   } catch (error) {
     const errMsg = typeof error === 'object' ? error.message : error;
+    report('run', { errMsg, appName: tmsConfig?.appName });
     fail(`构建出现错误: ${errMsg}`);
     info('详细错误信息', error);
     process.exit(1);
   }
 }
 
-function otherCommands(tmsConfig, commandName, cmd) {
+function otherCommands(tmsConfig, commandName, cmdOptions) {
   // 处理module参数
   const specificModuleNames = getSpecificModuleNames(
-    handleModuleArg(cmd),
+    handleModuleArg(cmdOptions),
     tmsConfig.modules,
   );
 
@@ -87,17 +91,29 @@ function otherCommands(tmsConfig, commandName, cmd) {
   switch (commandName) {
     case 'init':
       init(tmsConfig, newModules);
+      report('run:init', { appName: tmsConfig?.appName });
       return;
     case 'dev':
       global.setData('isDev', true);
       dev(tmsConfig, newModules);
+      report('run:dev', { appName: tmsConfig?.appName });
       return;
     case 'install':
       install(tmsConfig, subPackages, false);
+      report('run:install', { appName: tmsConfig?.appName });
       return;
     case 'build':
       global.setData('isDev', false);
       build(tmsConfig, newModules);
+      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/install/cache.js

@@ -0,0 +1,36 @@
+const fs = require('fs');
+const path = require('path');
+const { NPM_CACHE_FILE } = require('../../../config/constant');
+const { ensureDirExist } = require('../../../utils/io');
+
+function getCache(projectDir, type) {
+  const filePath = NPM_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 = NPM_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/scripts/run/install/index.js

@@ -4,8 +4,8 @@ const path = require('path');
 const io = require('../../../utils/io');
 const { createTask, resolve, getAbsolutePath } = require('../../../utils/widgets');
 const { buildMpNpm } = require('../../../core/mpCi');
-const { setCache, getCache } = require('../../../core/cache');
-const { CACHE_DIR } = require('../../../config/constant');
+const { setCache, getCache } = require('./cache');
+const { NODE_MODULES_DIR } = require('../../../config/constant');
 const { npmInstallAll } = require('../../../core/npm');
 const { info } = require('../../../utils/log');
 const { fileMd5 } = require('../../../utils/md5');
@@ -52,7 +52,7 @@ async function npmInstall(tmsConfig, subPackages, useCache) {
     if (fs.existsSync(modulePackagePath)) shelljs.cp('-Rf', modulePackagePath, outputModuleDir);
   });
 
-  await npmInstallAll(subPackages, resolve(tmsConfig.outputDir), `${CACHE_DIR}/node_modules`);
+  await npmInstallAll(subPackages, resolve(tmsConfig.outputDir), NODE_MODULES_DIR);
   return { isCache: false };
 }
 

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, getDefaultDesc } = 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 || getDefaultDesc(),
+    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 getDefaultDesc = () => {
+  const user =  getGitUser();
+  const date = moment().format('YYYY-MM-DD HH:mm:ss');
+  return `构建人: ${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,
+  getDefaultDesc,
+  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, getDefaultDesc } = 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 -v 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 || getDefaultDesc(),
+  };
+};
+
+/**
+ * 上传
+ * @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/log.js

@@ -40,9 +40,12 @@ const warn = (message) => {
 
 const info = (...args) => console.log(`${moment().format('YYYY-MM-DD HH:mm:ss')}`, ...args);
 
+const infoNoTime = (...args) => console.log(...args);
+
 module.exports = {
   fail,
   succeed,
   warn,
   info,
+  infoNoTime,
 };

package/src/utils/widgets.js

@@ -1,13 +1,10 @@
 
-const program = require('commander');
-const leven = require('leven');
 const ora = require('ora');
 const path = require('path');
 const fs = require('fs');
 const shelljs = require('shelljs');
 const glob = require('glob-ignore');
 const { info } = require('./log');
-const chalk = require('chalk');
 const shelljsOptions =  { slient: true, async: false };
 
 // 获取当前目录
@@ -16,28 +13,6 @@ function resolve(...args) {
   return path.resolve(cwd, ...args);
 };
 
-
-/**
- * 用户输入命令时，进行提示
- * @param {String} unknownCommand 非预期的命令
- * @returns {Undefined} 无需返回值
- */
-const suggestCommands = (unknownCommand) => {
-  const availableCommands = program.commands.map(cmd => cmd._name);
-
-  let suggestion;
-  availableCommands.forEach((cmd) => {
-    const isBestMatch = leven(cmd, unknownCommand) < leven(suggestion || '', unknownCommand);
-    if (leven(cmd, unknownCommand) < 3 && isBestMatch) {
-      suggestion = cmd;
-    }
-  });
-
-  if (suggestion) {
-    info(`  ${chalk.red(`Did you mean ${chalk.yellow(suggestion)}?`)}`);
-  }
-};
-
 /**
  * 判断变量是否是一个数组
  * @param { unknown } obj 变量
@@ -109,13 +84,15 @@ function pullRepoForGit(dest, branch) {
 
 /**
  * npm 下载依赖
- * @param {*} dir
+ * @param {string} dir 下载npm的目录
+ * @param {object} npm npm的配置 (见下获取npm源入参)
  * @returns
  */
-function npmInstall(dir) {
+function npmInstall(dir, npmConfig) {
   return new Promise((resolve, reject) => {
+    const registry = getNpmRegistry(npmConfig);
     shelljs.exec(
-      'npm install --production --registry http://mirrors.tencent.com/npm/',
+      `npm install --production ${registry}`,
       { cwd: dir, silent: true },
       (code, stdout, stderr) => {
         if (code !== 0) {
@@ -127,6 +104,28 @@ function npmInstall(dir) {
   });
 }
 
+// 获取npm源
+// 入参：{
+//   registry: "https://registry.npmjs.org/",
+//   scope: {
+//     "@tencent": "http://mirrors.tencent.com/npm/"
+//   }
+// }
+// 出参： --@tencent:registry=http://mirrors.tencent.com/npm/ --registry=https://registry.npmjs.org/
+function getNpmRegistry(npmConfig = {}) {
+  let resRegistry = '';
+  if (npmConfig.registry) {
+    resRegistry = ` --registry=${npmConfig.registry}`;
+  }
+
+  if (isObject(npmConfig.scope)) {
+    Object.keys(npmConfig.scope).forEach((key) => {
+      resRegistry += ` --${key}:registry=${npmConfig.scope[key]}`;
+    });
+  }
+  return resRegistry;
+}
+
 /**
  * 计算各项任务耗时
  * @param {Number} start 任务开始时间
@@ -167,11 +166,7 @@ const camelize = str => str.replace(/-(\w)/g, (a, c) => (c ? c.toUpperCase() : '
 
 const mergeMap = function (obj, src) {
   for (const [k, v] of src) {
-    if (obj.has(k)) {
-      obj.set(k, obj.get(k) + v);
-    } else {
-      obj.set(k, v);
-    }
+    obj.set(k, v);
   }
 
   return obj;
@@ -217,6 +212,30 @@ function getAbsolutePath(pathDir, cwd = '') {
   return newPath;
 }
 
+// 版本比较 => 1(大于), 0(等于), -1(小于)
+function versionCompare(v1, v2) {
+  // 将两个版本号拆成数组
+  const arr1 = v1.split('.');
+  const arr2 = v2.split('.');
+  const minLength = Math.min(arr1.length, arr2.length);
+  // 依次比较版本号每一位大小
+  for (let i = 0; i < minLength; i++) {
+    if (parseInt(arr1[i], 10) !== parseInt(arr2[i], 10)) {
+      return (parseInt(arr1[i], 10) > parseInt(arr2[i], 10)) ? 1 : -1;
+    }
+  }
+  // 若前几位分隔相同，则按分隔数比较。
+  if (arr1.length === arr2.length) {
+    return 0;
+  }
+  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,
@@ -224,7 +243,6 @@ module.exports = {
   createTask,
   downloadRepoForGit,
   pullRepoForGit,
-  suggestCommands,
   camelize,
   npmInstall,
   mergeMap,
@@ -232,4 +250,7 @@ module.exports = {
   filterField,
   findFiles,
   getAbsolutePath,
+  getNpmRegistry,
+  versionCompare,
+  getGitUser,
 };