@tmsfe/tmskit 0.0.24 → 0.0.27

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tmsfe/tmskit",
-  "version": "0.0.24",
+  "version": "0.0.27",
   "description": "tmskit",
   "main": "dist/index.cjs",
   "bin": {
@@ -33,6 +33,7 @@
     "@rollup/plugin-json": "^4.0.3",
     "rollup": "^2.6.1"
   },
+  "whiteDependencies": {},
   "dependencies": {
     "ansi-colors": "1.1.0",
     "anymatch": "^1.3.0",
@@ -40,7 +41,6 @@
     "chalk": "^4.1.0",
     "chokidar": "^3.5.3",
     "commander": "^8.3.0",
-    "copy-webpack-plugin": "^9.1.0",
     "ejs": "^3.1.5",
     "fancy-log": "1.3.2",
     "fs-extra": "^10.0.1",
@@ -55,10 +55,10 @@
     "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",
+    "ora": "^5.4.1",
     "path-is-absolute": "^1.0.1",
     "plugin-error": "^1.0.0",
     "postcss": "^8.4.6",
@@ -66,7 +66,7 @@
     "readable-stream": "^2.2.2",
     "replace-ext": "^2.0.0",
     "request": "^2.88.2",
-    "shelljs": "^0.8.4",
+    "shelljs": "^0.8.5",
     "slash": "^1.0.0",
     "strip-comments": "^2.0.1",
     "through2": "^4.0.2",
@@ -81,4 +81,4 @@
   "jest": {
     "testEnvironment": "jest-environment-node"
   }
-}
+}

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'];
 
@@ -118,6 +119,7 @@ module.exports = async (tmsConfig, modules, isDev = true) => {
         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,31 @@ 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,
+    },
+  },
+  npm: {
+    registry: 'https://registry.npmjs.org/',
+  },
 };

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/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,32 +41,66 @@ module.exports = [
           ['-e, --env [env]', '环境变量'],
           ['-noCache, --noCache', '不使用缓存功能'],
         ],
-        action: (cmd) => {
-          require('./scripts/run/index')('dev', cmd);
+        action: (cmdOptions) => {
+          require('./scripts/run/index')('dev', cmdOptions);
         },
       },
       {
-        command: 'cloud',
-        description: '云函数开发',
+        command: 'build',
+        description: 'prod 打包编译',
         options: [
           ['-m, --module [moduleName]', '模块名称'],
           ['-e, --env [env]', '环境变量'],
         ],
-        action: (cmd) => {
-          require('./scripts/run/index')('cloud', cmd);
+        action: (cmdOptions) => {
+          require('./scripts/run/index')('build', cmdOptions);
         },
       },
       {
-        command: 'build',
-        description: 'prod 打包编译',
+        command: 'preview',
+        description: '小程序预览',
         options: [
-          ['-m, --module [moduleName]', '模块名称'],
-          ['-e, --env [env]', '环境变量'],
+          ['-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 指定版本号'],
+          ['-d, --desc [desc]', '上传代码时的备注'],
+          ['-i, --info-output [infoOutput]', '相关信息会被输出到给定路径'],
+          ['-r, --robot [robot]', '指定使用哪一个 ci 机器人，可选值：1 ~ 30'],
+        ],
+        action: (cmdOptions) => {
+          require('./scripts/run/index')('upload', cmdOptions);
+        },
+      },
+      {
+        command: 'cloud-dev',
+        description: '云函数开发',
+        options: [
+          ['--cloud [cloud]', '模块名称'],
         ],
-        action: (cmd) => {
-          require('./scripts/run/index')('build', cmd);
+        action: (cmdOptions) => {
+          require('./scripts/run/index')('cloud-dev', cmdOptions);
         },
       },
+      // {
+      //   command: 'cloud-link',
+      //   description: '云函数开发',
+      //   options: [
+      //     ['--cloud [cloud]', '模块名称'],
+      //   ],
+      //   action: (cmdOptions) => {
+      //     require('./scripts/run/index')('cloud-link', 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?.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/check.js

@@ -0,0 +1,34 @@
+const fs = require('fs');
+
+/**
+ * 检查云函数的配置项
+ * @param {*} tmsConfig
+ */
+function checkCloudConfig(tmsConfig) {
+  if (!tmsConfig.cloudModules) {
+    return '你没有在tms.config.js的cloudModules注册云函数';
+  }
+  if (!tmsConfig.cloudDir) {
+    return '你没有在tms.config.js配置云函数编译目录cloudDir';
+  }
+  return;
+}
+
+/**
+ * 检查云函数源码目录是否存在
+ * @param {Array} clouds [{name: '', sourcePath: '', targetPath: ''}]
+ */
+function checkSrcPathIsExist(clouds) {
+  for (const item of clouds) {
+    if (!fs.existsSync(item.sourcePath)) {
+      return `${item.name}云函数的${item.sourcePath}目录不存在, 请检查tms.config.js>cloudModules>all云函数的配置目录`;
+    }
+  }
+  return;
+}
+
+
+module.exports = {
+  checkCloudConfig,
+  checkSrcPathIsExist,
+};

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

@@ -0,0 +1,146 @@
+const shellJs = require('shelljs');
+const ora = require('ora');
+const path = require('path');
+const chalk = require('chalk');
+const { resolve, createTask } = require('../../../utils/widgets');
+const { handleError } = require('../../../core/handleError');
+const { ensureDirExist } = require('../../../utils/io');
+const { src, dest, parallel, series } = require('gulp');
+const watch = require('../../../compile/plugins/gulp-watch');
+const { info, fail } = require('../../../utils/log');
+const getCloudsOfListen = require('./getClouds');
+const { checkCloudConfig, checkSrcPathIsExist } = require('./check');
+const { runInstall } = require('./install');
+
+/**
+ * 获取云函数的编译任务
+ * @param {array} clouds  [{name: '', sourcePath: '', targetPath: ''}]
+ * @param {object} srcOption gulp.src的参数
+ * @returns Map {'${sourcePath}': {taskFn: () => {}, targetPath: 'xxx'}}
+ */
+const getCompileTasks = (clouds, srcOption) => {
+  const compileTasksMap = new Map();
+  clouds.forEach((item) => {
+    compileTasksMap.set(item.sourcePath, {
+      targetPath: item.targetPath,
+      taskFn: (sourceFile, targetPath) => {
+        const newGlobValue = Array.isArray(sourceFile) ? sourceFile : `${item.sourcePath}/**/*`;
+        const newDestPath = targetPath ? targetPath : item.targetPath;
+
+        const srcPipe = src(newGlobValue, srcOption);
+        return srcPipe
+          .pipe(dest(newDestPath))
+          .on('error', (err) => {
+            fail(`监听报错${err}`);
+          });
+      },
+    });
+  });
+  return compileTasksMap;
+};
+
+const getTargetFile = (sourceFile, sourcePath, targetPath) => {
+  const sourceFileRelativeModule = path.relative(sourcePath, sourceFile);
+  const targetFile = resolve(targetPath, sourceFileRelativeModule);
+  return targetFile;
+};
+
+/**
+ * 开始启动编译
+ * @param {Map} compileTasksMap {'${sourcePath}': {taskFn: () => {}, targetPath: 'xxx'}}
+ */
+const runCompile = (compileTasksMap, callback) => {
+  async function end(next) {
+    // 监听其他文件
+    compileTasksMap.forEach(({ taskFn, targetPath }, sourcePath) => {
+      runWatch(
+        sourcePath,
+        { ignoreInitial: true, events: ['add', 'change', 'unlink', 'addDir', 'unlinkDir'] },
+        taskFn,
+        targetPath,
+      );
+    });
+    callback && callback();
+    next();
+  }
+
+  const compileTasksArr = [];
+  compileTasksMap.forEach(({ taskFn }) => {
+    compileTasksArr.push(taskFn);
+  });
+  // 一次性完成编译任务（编译完成后再添加watch任务-封装到end函数里面）
+  series(parallel(...compileTasksArr), end)();
+};
+
+/**
+ * 监听文件变动
+ * @param {*} sourcePath 云函数的源码目录
+ * @param {*} watchOptions gulp-watch的参数
+ * @param {*} callback  监听到变动的回调
+ * @param {*} targetPath 云函数的编译目录
+ */
+const runWatch = (sourcePath, watchOptions, callback, targetPath) => {
+  watch(sourcePath, {
+    ...watchOptions,
+  }, (vinyl) => {
+    const sourceFile = vinyl.history[0];
+    const sourceFileDirArr = sourceFile.replace(/\\/g, '/').split('/');
+    const sourceFileName = sourceFileDirArr.slice(sourceFileDirArr.length - 2).join('/');
+
+    const targetFile = getTargetFile(sourceFile, sourcePath, targetPath);
+    if (vinyl.event === 'unlink' || vinyl.event === 'unlinkDir') {
+      info(`删除${sourceFileName}`);
+      shellJs.rm('-rf', targetFile);
+      return;
+    }
+    info(`${sourceFileName}有更新`);
+    return callback([sourceFile],  path.dirname(targetFile));
+  });
+};
+
+
+module.exports = async (tmsConfig, cmdOptions) => {
+  try {
+    const sTime = new Date().getTime();
+    const spinner = ora();
+    spinner.start();
+
+    // 检查云函数的配置项
+    const configErrMsg = checkCloudConfig(tmsConfig);
+    if (configErrMsg) {
+      throw new Error(configErrMsg);
+    }
+
+    // 确保云函数的编译目录存在
+    ensureDirExist(resolve(tmsConfig.cloudDir));
+
+    // 获取需要监听的云函数列表
+    const clouds = getCloudsOfListen(tmsConfig, cmdOptions);
+    // 检查云函数源码目录是否存在
+    const srcNotExistErrMsg = checkSrcPathIsExist(clouds);
+    if (srcNotExistErrMsg) {
+      throw new Error(srcNotExistErrMsg);
+    }
+
+    // 打印启动云函数列表
+    info('当前启动云函数列表:', clouds.map(item => item.name).sort());
+
+    // npm install
+    await createTask(
+      runInstall,
+      '开始npm install',
+      'npm install完成',
+    )(clouds, tmsConfig);
+
+    // 获取云函数列表的编译任务
+    const compileTasksMap = getCompileTasks(clouds, { allowEmpty: true });
+    runCompile(compileTasksMap, () => {
+      const eTime = new Date().getTime() - sTime;
+      spinner.succeed(chalk.green(`首次编译完成, 耗时${eTime / 1000}s, 微信开发者工具打开项目即可预览。`));
+      spinner.stop();
+    });
+  } catch (e) {
+    info('编译出现详细错误', e);
+    handleError(`编译出现错误: ${e}`, true);
+  }
+};