@tmsfe/tmskit 0.0.23 → 0.0.24-beta.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tmsfe/tmskit",
-  "version": "0.0.23",
+  "version": "0.0.24-beta.0",
   "description": "tmskit",
   "main": "dist/index.cjs",
   "bin": {
@@ -55,7 +55,7 @@
     "lodash": "^4.17.21",
     "metalsmith": "^2.3.0",
     "minimatch": "^5.1.0",
-    "miniprogram-ci": "1.4.13",
+    "miniprogram-ci": "1.8.25",
     "moment": "^2.29.2",
     "object-assign": "^4.0.1",
     "ora": "^5.1.0",

package/src/compile/dev.js

@@ -10,6 +10,7 @@ const compile = require('./compile');
 const watch = require('./watch');
 const { info } = require('../utils/log');
 const report = require('../core/report');
+const { global } = require('../utils/global');
 
 const watchEvents = ['add', 'change', 'unlink', 'addDir', 'unlinkDir'];
 
@@ -113,11 +114,12 @@ module.exports = async (tmsConfig, modules, isDev = true) => {
       buildOutputAppJson(tmsConfig, modules, isDev);
     }
     eTime = new Date().getTime() - sTime;
-    if (typeof tmsConfig?.hooks?.afterCompile === 'function') {
-      await tmsConfig?.hooks?.afterCompile({
+    if (typeof tmsConfig?.hooks?.afterFirstCompile === 'function') {
+      await tmsConfig?.hooks?.afterFirstCompile({
         isDev,
         tmsConfig: filterField(tmsConfig, ['gitAccount']),
         modules,
+        cmdOptions: global.getData('cmdOptions'),
       });
       report('hooks:afterCompile');
     }

package/src/compile/watch.js

@@ -107,6 +107,7 @@ async function updateFileHook(tmsConfig, sourceFile, targetFile, type) {
   if (typeof tmsConfig?.hooks?.updateFile === 'function') {
     await tmsConfig.hooks.updateFile({
       tmsConfig: filterField(tmsConfig, ['gitAccount']),
+      cmdOptions: global.getData('cmdOptions'),
       sourceFile,
       targetFile,
       type,

package/src/config/defaultTmsConfig.js

@@ -13,4 +13,28 @@ module.exports = {
   sourceDir: './',
   /** 静态资源目录 */
   static: [],
+  /** 上传是的配置  https://developers.weixin.qq.com/miniprogram/dev/devtools/ci.html#%E7%BC%96%E8%AF%91%E8%AE%BE%E7%BD%AE */
+  upload: {
+    setting: {
+      es6: true,
+      es7: true,
+      minify: true,
+      minifyJS: true,
+      minifyWXML: true,
+      minifyWXSS: true,
+      autoPrefixWXSS: true,
+    },
+  },
+  /** 预览的配置 https://developers.weixin.qq.com/miniprogram/dev/devtools/ci.html#%E9%A2%84%E8%A7%88  */
+  preview: {
+    setting: {
+      es6: true,
+      es7: true,
+      minify: true,
+      minifyJS: true,
+      minifyWXML: true,
+      minifyWXSS: true,
+      autoPrefixWXSS: true,
+    },
+  },
 };

package/src/core/buildAppJson.js

@@ -143,6 +143,7 @@ function buildOutputAppJson(tmsConfig, modules) {
     if (typeof tmsConfig?.hooks?.updateAppJson === 'function') {
       tmsConfig?.hooks?.updateAppJson({
         tmsConfig: filterField(tmsConfig, ['gitAccount']),
+        cmdOptions: global.getData('cmdOptions'),
         modules,
         appJson,
         isDev: global.getData('isDev'),

package/src/core/cache.js

@@ -0,0 +1,36 @@
+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/cloneModules.js

@@ -21,7 +21,8 @@ function replaceGitUrlAccount(httpRepoUrl, moduleName) {
   const tmsConfig = global.getData('tmsConfig');
 
   let gitUrl = httpRepoUrl;
-  const { username = '', pass = '' } = tmsConfig?.gitAccount?.[moduleName] || {};
+
+  const { username = '', pass = '' } = tmsConfig?.gitAccount?.[moduleName] || tmsConfig?.gitAccount?.[httpRepoUrl] || {};
 
   const urlPrefixReg = /http(s)?:\/\//;
   if (username && pass && urlPrefixReg.test(gitUrl)) {
@@ -150,7 +151,6 @@ function collectDownLoadTasksMap(sourceDir, targetDir,  modules) {
           ]);
         },
       };
-
       if (downloadTasksMap.has(sourcePath)) {
         const task = downloadTasksMap.get(sourcePath);
         task.callbacks.push(callback);
@@ -159,7 +159,7 @@ function collectDownLoadTasksMap(sourceDir, targetDir,  modules) {
         let promiseTask;
         if (fs.existsSync(sourcePath) && fs.existsSync(`${sourcePath}/.git`)) {
           promiseTask = (gitUrl, sourcePath, branch, httpRepoUrl) => {
-            info(`git pull:${httpRepoUrl}`);
+            info(`git pull:${httpRepoUrl} --branch: ${branch}`);
             return pullRepoForGit(sourcePath, branch);
           };
         } else {

package/src/core/mpCi.js

@@ -6,8 +6,8 @@ const path = require('path');
  * @returns {Object} 小程序ci对象
  */
 const getMpCi = ({ appId, projectPath, type = 'miniProgram', privateKey = 'TODO' }) => {
-  const cfgJsonContent = require(path.join(projectPath, 'project.config.json'));
-  const ignores = cfgJsonContent?.packOptions?.ignore.map(({ value }) => value) || [];
+  const projectCg = require(path.join(projectPath, 'project.config.json'));
+  const ignores = projectCg?.packOptions?.ignore?.map(({ value }) => value) || [];
 
   return new ci.Project({
     appid: appId,
@@ -18,14 +18,6 @@ const getMpCi = ({ appId, projectPath, type = 'miniProgram', privateKey = 'TODO'
   });
 };
 
-
-// 用小程序ci工具构建小程序
-const packMpProject = async (project) => {
-  await ci.packNpm(project, {
-    ignores: ['cloud/**/*'],
-  });
-};
-
 /**
  * 格式化构建npm结果信息
  * @param {Array<String>} warning 构建时的告警信息
@@ -43,21 +35,27 @@ const formatPackNpmWarning = (warning) => {
 };
 
 /**
- * 构建miniprogram_npm
- *  @returns {Object} 小程序ci对象
+ * 构建miniprogram_npm https://developers.weixin.qq.com/miniprogram/dev/devtools/ci.html#%E6%9E%84%E5%BB%BAnpm
+ * * @param {object} {
+ *  appId,
+ *  peojectPath,
+ *  privateKey,
+ * }
  */
 const buildMpNpm = async ({
   appId,
   projectPath,
   privateKey,
 }) => {
-  const mpCi = await getMpCi({
+  const mpCi = getMpCi({
     appId,
     projectPath,
     privateKey,
   });
 
-  const packNpmWarning = await packMpProject(mpCi);
+  const packNpmWarning = await ci.packNpm(mpCi, {
+    ignores: ['cloud/**/*'],
+  });
 
   const packNpmMsg = formatPackNpmWarning(packNpmWarning);
   if (packNpmMsg) {
@@ -67,7 +65,57 @@ const buildMpNpm = async ({
   return Promise.resolve();
 };
 
+/**
+ * 预览小程序码 https://developers.weixin.qq.com/miniprogram/dev/devtools/ci.html#%E9%A2%84%E8%A7%88
+ * @param {object} {
+ *  appId,
+ *  peojectPath,
+ *  privateKey,
+ *  desc
+ *  robot
+ * }
+ */
+const previewMp = async (params = {}) => {
+  const { appId, projectPath, privateKey, ...resetParams } = params;
+  const mpCi = await getMpCi({
+    appId,
+    projectPath,
+    privateKey,
+  });
+
+  return await ci.preview({
+    project: mpCi,
+    ...resetParams,
+    onProgressUpdate: () => {},
+  });
+};
+
+/**
+ * 上传小程序 https://developers.weixin.qq.com/miniprogram/dev/devtools/ci.html#%E4%B8%8A%E4%BC%A0
+ * @param {object} {
+ *  appId,
+ *  peojectPath,
+ *  privateKey,
+ *  version,
+ *  desc
+ * }
+ */
+const uploadMp = async (params = {}) => {
+  const { appId, projectPath, privateKey, ...resetParams } = params;
+  const mpCi = await getMpCi({
+    appId,
+    projectPath,
+    privateKey,
+  });
+  return await ci.upload({
+    project: mpCi,
+    ...resetParams,
+    onProgressUpdate: () => {},
+  });
+};
 
 module.exports = {
   buildMpNpm,
+  previewMp,
+  uploadMp,
 };

package/src/core/report.js

@@ -1,12 +1,7 @@
 const request = require('request');
-const shelljs = require('shelljs');
+const { getGitUser } = require('../utils/widgets');
 const apiUrl = 'https://tim.map.qq.com/basic/tmskit/upload';
 
-function getGitUser() {
-  const res = shelljs.exec('git config user.name', { async: false, silent: true });
-  return res.stdout;
-}
-
 const report = (name, attrs = {}) => {
   try {
     const param = [];
@@ -19,7 +14,7 @@ const report = (name, attrs = {}) => {
       if (!param[i]) param[i] = null;
     };
 
-    request.post({ url: apiUrl, json: { param } });
+    request.post({ url: apiUrl, json: { param } }, () => {});
     // (error, response, body) => {
     //   console.log('body:', body);
     // }

package/src/core/tmsMpconfig.js

@@ -118,20 +118,8 @@ function adaptMpCgContent(fileContent, appName) {
   return content;
 }
 
-const adaptDependencies = function (dependencies, subPackages) {
-  const newDependencies = dependencies || [];
-  subPackages.forEach((item) => {
-    if (item.dependencies) {
-      dependencies = newDependencies.concat(item.dependencies);
-    }
-  });
-  return newDependencies;
-};
-
 const adaptSubPackages = function (moduleConfig, appName) {
-  const subPackages = isObject(moduleConfig) && moduleConfig.subPackages
-    ? moduleConfig.subPackages
-    : isObject(moduleConfig) ? [moduleConfig] : moduleConfig;
+  const { subPackages } = moduleConfig;
   return adaptMpCgContent(subPackages, appName);
 };
 
@@ -153,11 +141,9 @@ function getModulesConfig(modules = [], appName) {
 
     // 兼容历史逻辑，后续可删除--- start
     const subPackages = adaptSubPackages(moduleConfig, appName);
-    const dependencies = adaptDependencies(moduleConfig.dependencies, subPackages);
     moduleConfig = {
       ...(isObject(moduleConfig) ? moduleConfig : {}),
       subPackages,
-      dependencies,
     };
     // 兼容逻辑--- end
     modulesConfig.push(moduleConfig);
@@ -210,10 +196,6 @@ const  getSubPackageSrcPath = function (tmsConfig, module, subPackage) {
 const checkModuleItem = (tmsConfig, tmsModuleItem, moduleConfig) => {
   const newModuleItem = { ...tmsModuleItem, ...moduleConfig };
 
-  // 兼容逻辑
-  if (!newModuleItem.moduleName) newModuleItem.moduleName = newModuleItem.name;
-  delete newModuleItem.name;
-
   // 参数校验-模块源码路径
   if (!newModuleItem.path) {
     throw new Error(`${newModuleItem.moduleName}模块没有找到path字段，请检查tms.config.js的modules.all>module>path路径`);
@@ -250,6 +232,9 @@ const getModulesByMergeDepModules = (tmsConfig, modules, errorIsQuit = false) =>
   const allModules = new Map();
   function dfs(tmsConfig, modules) {
     modules.forEach((moduleItem) => {
+      if (!moduleItem.path) {
+        throw new Error(`${moduleItem.moduleName}模块没有找到path字段，请检查tms.config.js的modules.all>module>path路径`);
+      }
       const moduleConfigPath = resolve(moduleItem.path, MODULE_CONFIG_FILENAME);
       if (!fs.existsSync(moduleConfigPath)) {
         if (!allModules.has(moduleItem.moduleName)) {

package/src/entry.js

@@ -12,9 +12,9 @@ module.exports = [
     options: [
       ['--registry [registry]', 'npm源'],
     ],
-    action: (npmName, cmd) => {
+    action: (npmName, cmdOptions) => {
       const res = require('./scripts/extend-cmd');
-      res.installCmd(npmName, cmd);
+      res.installCmd(npmName, cmdOptions);
     },
   },
   {
@@ -29,8 +29,8 @@ module.exports = [
           ['-m, --module [moduleName]', '模块名称'],
           ['-e, --env [env]', '环境变量'],
         ],
-        action: (cmd) => {
-          require('./scripts/run/index')('install', cmd);
+        action: (cmdOptions) => {
+          require('./scripts/run/index')('install', cmdOptions);
         },
       },
       {
@@ -41,8 +41,8 @@ module.exports = [
           ['-e, --env [env]', '环境变量'],
           ['-noCache, --noCache', '不使用缓存功能'],
         ],
-        action: (cmd) => {
-          require('./scripts/run/index')('dev', cmd);
+        action: (cmdOptions) => {
+          require('./scripts/run/index')('dev', cmdOptions);
         },
       },
       {
@@ -52,8 +52,8 @@ module.exports = [
           ['-m, --module [moduleName]', '模块名称'],
           ['-e, --env [env]', '环境变量'],
         ],
-        action: (cmd) => {
-          require('./scripts/run/index')('cloud', cmd);
+        action: (cmdOptions) => {
+          require('./scripts/run/index')('cloud', cmdOptions);
         },
       },
       {
@@ -63,8 +63,33 @@ module.exports = [
           ['-m, --module [moduleName]', '模块名称'],
           ['-e, --env [env]', '环境变量'],
         ],
-        action: (cmd) => {
-          require('./scripts/run/index')('build', cmd);
+        action: (cmdOptions) => {
+          require('./scripts/run/index')('build', cmdOptions);
+        },
+      },
+      {
+        command: 'preview',
+        description: '小程序预览',
+        options: [
+          ['-f, --qrcodeFormat [qrcodeFormat]', '二维码的格式，选项terminal, image, base64。默认terminal'],
+          ['-o, --qrcodeOutputDest [qrcodeOutputDest]', '二维码会被输出到给定路径'],
+          ['-i, --info-output [infoOutput]', '相关信息会被输出到给定路径'],
+        ],
+        action: (cmdOptions) => {
+          require('./scripts/run/index')('preview', cmdOptions);
+        },
+      },
+      {
+        command: 'upload',
+        description: '小程序上传',
+        options: [
+          ['-version, --version [version]', '上传代码版本，version 指定版本号'],
+          ['-d, --desc [desc]', '上传代码时的备注'],
+          ['-i, --info-output [infoOutput]', '相关信息会被输出到给定路径'],
+          ['-r, --robot [robot]', '指定使用哪一个 ci 机器人，可选值：1 ~ 30'],
+        ],
+        action: (cmdOptions) => {
+          require('./scripts/run/index')('upload', cmdOptions);
         },
       },
     ],

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

@@ -1,21 +1,26 @@
 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

@@ -28,7 +28,7 @@ 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);
@@ -41,11 +41,12 @@ async function dev(tmsConfig, targetModules) {
   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');
   };

package/src/scripts/run/index.js

@@ -3,6 +3,8 @@ 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');
@@ -14,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 [];
 };
@@ -45,13 +47,13 @@ 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,
     });
 
@@ -60,7 +62,7 @@ async function run(commandName, cmd) {
       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 });
@@ -70,10 +72,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,
   );
 
@@ -105,6 +107,14 @@ function otherCommands(tmsConfig, commandName, cmd) {
       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/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;