@tmsfe/tmskit 0.0.7 → 0.0.8

package/src/core/cloneModules.js

@@ -0,0 +1,203 @@
+/**
+ * 下载第三方代码
+ */
+const MetalSmith = require('metalsmith');
+const crypto = require('crypto');
+const { downloadRepoForGit, pullRepoForGit, resolve } = require('../utils/widgets');
+const { fail, info } = require('../utils/log');
+const fs = require('fs');
+const shelljs = require('shelljs');
+const { handleError } = require('./handleError');
+const { global } = require('../utils/global');
+
+/**
+ * 处理用户没有clone git仓库权限问题,拼接tms.private.config.js的账号信息
+ * @param {*} httpRepoUrl
+ * @param {*} moduleName
+ * @returns
+ */
+function replaceGitUrlAccount(httpRepoUrl, moduleName) {
+  // 用户本地的私有项目配置（用来配置环境\模块信息\账号信息）
+  const tmsPrivateCf = global.getData('tmsPrivateCf');
+
+  let gitUrl = httpRepoUrl;
+  const { username = '', pass = '' } = tmsPrivateCf?.gitAccout?.[moduleName] || {};
+
+  const urlPrefixReg = /http(s)?:\/\//;
+  if (username && pass && urlPrefixReg.test(gitUrl)) {
+    gitUrl = gitUrl.replace(urlPrefixReg, val => `${val}${encodeURIComponent(username)}:${pass}@`);
+  }
+
+  return gitUrl;
+}
+
+/**
+ * 对克隆下来的模块进行相应的文件处理操作，比如收集处理模块信息，进行信息缓存等操作
+ * @param { string } sourceDir 缓存文件夹
+ * @param { string } targetDir 目标文件夹
+ * @param { arrary } ignore
+ * @returns { undefined } no return
+ */
+function moveFile(sourceDir, targetDir, ignore = []) {
+  // 删除不是文件夹的文件
+  return new Promise((resolve, reject) => {
+    MetalSmith(__dirname)
+      .ignore(ignore)
+      .source(sourceDir)
+      .destination(targetDir)
+      .build((e) => {
+        if (e) {
+          fail(`${sourceDir} moveFile ${targetDir}出现错误: ${e}`);
+          reject(e);
+        }
+        resolve();
+      });
+  });
+}
+
+/**
+ * 根据gitUrl 和 branch取md5值
+ * @param {*} gitUrl
+ * @param {*} branch
+ * @returns
+ */
+function md5ByGitUrlBranch(gitUrl, branch) {
+  const newBranch =  branch && typeof branch === 'string' ? branch : 'master';
+  return crypto.createHash('md5').update(JSON.stringify({ gitUrl, branch: newBranch }))
+    .digest('hex');
+}
+
+/**
+ * 下载目标模块
+ * @param { string } sourceDir 缓存文件夹
+ * @param { string } targetDir 目标文件夹
+ * @returns { array } modules 描述模块的列表
+ */
+async function cloneModules(sourceDir, targetDir, modules) {
+  // 收集下载模块代码的任务
+  const downloadTasksMap = collectDownLoadTasksMap(sourceDir, targetDir, modules);
+
+  // 开始执行下载和移动代码的任务
+  const arrPromises = [];
+  downloadTasksMap.forEach(({ promiseTask, params, callbacks }) => {
+    arrPromises.push(promiseTask(...Object.keys(params).map(key => params[key]))
+      .then(async () => {
+        const callArr = callbacks.map(async ({
+          params: cParams,
+          fn,
+        }) => fn(...Object.keys(cParams).map(key => cParams[key])));
+        return Promise.all(callArr);
+      })
+      .catch((e) => {
+        handleError(`下载代码${params.httpRepoUrl}出现错误：${e}`);
+      }));
+  });
+
+  await Promise.all(arrPromises);
+}
+
+/**
+ * 收集下载模块代码的任务
+ * @param { string } sourceDir 代码缓存文件夹
+ * @param { string } targetDir 代码要放到的目标文件夹
+ * @returns { array } modules 描述模块的列表
+ */
+function collectDownLoadTasksMap(sourceDir, targetDir,  modules) {
+  // 下载代码任务 Map (key解释 缓存代码路径/md5(gitUrl,branch)
+  // {
+  // '/Users/odile/.tmskit/modules_code/026cb72509c2369dbd75779181f820bc': {
+  //   promiseTask, 下载代码的任务
+  //   params: { 下载代码时的参数
+  //       gitUrl,
+  //       sourcePath,
+  //       branch,
+  //   },
+  //   callbacks: [callback],// 下载完代码后的回调
+  //  }
+  // }
+  const downloadTasksMap = new Map();
+  for (const moduleInfo of modules) {
+    if (moduleInfo.repoInfo) {
+      const { repoInfo: { buildGitTag: branch, httpRepoUrl, path: gitPath = '' }, path, name } = moduleInfo;
+
+      // 处理仓库权限问题
+      const gitUrl = replaceGitUrlAccount(httpRepoUrl, name);
+      // 根据gitUrl与branch计算md5
+      const md5Key = md5ByGitUrlBranch(gitUrl, branch);
+      // git源码临时存在的源目录
+      const sourcePath = resolve(sourceDir, md5Key);
+      // 模块源码要放到目标目录
+      const targetPath = resolve(targetDir, path);
+      // 从git源码仓库中找到模块源码路径 (一个仓库存在存放多个模块的情况)
+      const sourceModulePath = gitPath ? `${sourcePath}/${gitPath}` : sourcePath;
+
+      // 下载完代码后，添加回调函数（主要将模块代码从临时目录移动代码到目标目录）
+      const callback = {
+        params: { sourceModulePath, targetPath },
+        fn: async (sourceModulePath, targetPath) => {
+          if (fs.existsSync(targetPath)) {
+            shelljs.rm('-rf', `${targetPath}/*`);
+          }
+
+          await moveFile(`${sourceModulePath}`, targetPath, [
+            'node_modules',
+            '.git',
+          ]);
+        },
+      };
+
+      if (downloadTasksMap.has(sourcePath)) {
+        const task = downloadTasksMap.get(sourcePath);
+        task.callbacks.push(callback);
+        downloadTasksMap.set(sourcePath, task);
+      } else {
+        let promiseTask;
+        if (fs.existsSync(sourcePath) && fs.existsSync(`${sourcePath}/.git`)) {
+          promiseTask = (gitUrl, sourcePath, branch, httpRepoUrl) => {
+            info(`git pull仓库:${httpRepoUrl}`);
+            return pullRepoForGit(sourcePath, branch);
+          };
+        } else {
+          promiseTask = (gitUrl, sourcePath, branch, httpRepoUrl) => {
+            info(`git clone仓库: ${httpRepoUrl}`);
+            return downloadRepoForGit(gitUrl, sourcePath, branch);
+          };
+        }
+        downloadTasksMap.set(sourcePath, {
+          promiseTask,
+          params: {
+            gitUrl,
+            sourcePath,
+            branch,
+            httpRepoUrl,
+          },
+          callbacks: [callback],
+        });
+      }
+    }
+  }
+  return downloadTasksMap;
+}
+
+/**
+ * 检查远程模块的gitUrl与 branch是否有更新
+ * @param {string} sourceDir 模块源码在缓存区的目录
+ * @param {object} moduleInfo 模块的配置信息
+ * @returns
+ */
+function checkRemoteModGitUrlBranch(sourceDir, moduleInfo) {
+  if (moduleInfo.repoInfo) {
+    const { repoInfo: { buildGitTag, httpRepoUrl }, name } = moduleInfo;
+    const gitUrl = replaceGitUrlAccount(httpRepoUrl, name);
+    const md5Key = md5ByGitUrlBranch(gitUrl, buildGitTag);
+    if (!fs.existsSync(`${sourceDir}/${md5Key}`)) {
+      return true;
+    }
+  }
+  return false;
+}
+
+module.exports = {
+  cloneModules,
+  checkRemoteModGitUrlBranch,
+};

package/src/{utils → core}/handleError.js

@@ -1,16 +1,18 @@
-const { fail } = require('./log');
-
-function handleError(error, isDev = false) {
-  const errMsg = typeof error === 'object' ? error.message : error;
-  if (isDev) {
-    fail(errMsg);
-  } else {
-    fail(errMsg);
-    process.exit(1);
-  }
-}
-
-module.exports = {
-  handleError,
-};
-
+const { fail } = require('../utils/log');
+const { global } = require('../utils/global');
+
+function handleError(error) {
+  const errMsg = typeof error === 'object' ? error.message : error;
+  const isDev = global.getData('isDev');
+  if (isDev) {
+    fail(errMsg);
+  } else {
+    fail(errMsg);
+    process.exit(1);
+  }
+}
+
+module.exports = {
+  handleError,
+};
+

package/src/core/isInIt.js

@@ -0,0 +1,69 @@
+const fs = require('fs');
+const { resolve } = require('../utils/widgets');
+const { MODULE_CONFIG_FILENAME, MODULE_CODE_DIR } = require('../config/constant');
+const { checkRemoteModGitUrlBranch } = require('./cloneModules');
+const { checkDependencies } = require('./checkDependencies');
+const { fail } = require('../utils/log');
+
+function checkModule(targetModules, contextDir) {
+  // 判断\源码\dist\是否存在用户指定的模块
+  for (const item of targetModules) {
+    // 此模块没有root字段(原因：没有merge到module.config.json的配置项。第三方模块的代码可能还没有下载)
+    if (!item.root) {
+      return true;
+    }
+    // 判断dist目录是否有该模块
+    if (!fs.existsSync(`${contextDir}/${item.root}/${MODULE_CONFIG_FILENAME}`)) {
+      return true;
+    }
+
+    // 判断第三方远程模块git地址与branch是否有更新
+    if (checkRemoteModGitUrlBranch(MODULE_CODE_DIR, item)) {
+      return true;
+    }
+
+    // 判断源码目录是否有该模块
+    if (item.path && !fs.existsSync(resolve(item.path))) {
+      fail(`${item.path}模块代码路径不存在, 请检查tms.config.js的${item.name}模块的path`);
+      process.exit(1);
+    }
+  }
+  return false;
+}
+
+function isInit(tmsConfig, targetModules, contextDir) {
+  // 判断是否存在dist目录
+  if (!fs.existsSync(contextDir)) {
+    return true;
+  }
+  // 判断dist是否存在node_modules
+  if (!fs.existsSync(`${contextDir}/node_modules`)) {
+    return true;
+  }
+
+  // 判断dist是否存在miniprogram_npm
+  if (!fs.existsSync(`${contextDir}/miniprogram_npm`)) {
+    return true;
+  }
+
+  // 判断dist是否存在app.json
+  if (!fs.existsSync(`${contextDir}/app.json`)) {
+    return true;
+  }
+
+  // 判断模块信息
+  if (checkModule(targetModules, contextDir)) {
+    return true;
+  }
+
+  //  判断package.json的版本是否有新的版本
+  if (checkDependencies(targetModules, resolve('./'), tmsConfig.outputDir)) {
+    return true;
+  }
+  return false;
+}
+
+
+module.exports = {
+  isInit,
+};

package/src/{utils/mpCiUtils.js → core/mpCi.js}

@@ -1,73 +1,73 @@
-const ci = require('miniprogram-ci');
-const path = require('path');
-
-/**
- * 获取小程序ci的Project对象
- * @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) || [];
-
-  return new ci.Project({
-    appid: appId,
-    privateKey,
-    type,
-    projectPath,
-    ignores: ['node_modules/**/*', ...ignores],
-  });
-};
-
-
-// 用小程序ci工具构建小程序
-const packMpProject = async (project) => {
-  await ci.packNpm(project, {
-    ignores: ['cloud/**/*'],
-  });
-};
-
-/**
- * 格式化构建npm结果信息
- * @param {Array<String>} warning 构建时的告警信息
- * @returns {String} npm构建错误信息
- */
-const formatPackNpmWarning = (warning) => {
-  if (!warning) {
-    return '';
-  }
-
-  const result = warning.map((it, index) => `${index + 1}. ${it.msg}
-  \t@ ${it.jsPath}:${it.tips}`).join('---------------\n');
-
-  return result;
-};
-
-/**
- * 构建miniprogram_npm
- *  @returns {Object} 小程序ci对象
- */
-const buildMpNpm = async ({
-  appId,
-  projectPath,
-  privateKey,
-}) => {
-  const mpCi = await getMpCi({
-    appId,
-    projectPath,
-    privateKey,
-  });
-
-  const packNpmWarning = await packMpProject(mpCi);
-
-  const packNpmMsg = formatPackNpmWarning(packNpmWarning);
-  if (packNpmMsg) {
-    return Promise.reject(packNpmMsg);
-  }
-
-  return Promise.resolve();
-};
-
-
-module.exports = {
-  buildMpNpm,
-};
+const ci = require('miniprogram-ci');
+const path = require('path');
+
+/**
+ * 获取小程序ci的Project对象
+ * @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) || [];
+
+  return new ci.Project({
+    appid: appId,
+    privateKey,
+    type,
+    projectPath,
+    ignores: ['node_modules/**/*', ...ignores],
+  });
+};
+
+
+// 用小程序ci工具构建小程序
+const packMpProject = async (project) => {
+  await ci.packNpm(project, {
+    ignores: ['cloud/**/*'],
+  });
+};
+
+/**
+ * 格式化构建npm结果信息
+ * @param {Array<String>} warning 构建时的告警信息
+ * @returns {String} npm构建错误信息
+ */
+const formatPackNpmWarning = (warning) => {
+  if (!warning) {
+    return '';
+  }
+
+  const result = warning.map((it, index) => `${index + 1}. ${it.msg}
+  \t@ ${it.jsPath}:${it.tips}`).join('---------------\n');
+
+  return result;
+};
+
+/**
+ * 构建miniprogram_npm
+ *  @returns {Object} 小程序ci对象
+ */
+const buildMpNpm = async ({
+  appId,
+  projectPath,
+  privateKey,
+}) => {
+  const mpCi = await getMpCi({
+    appId,
+    projectPath,
+    privateKey,
+  });
+
+  const packNpmWarning = await packMpProject(mpCi);
+
+  const packNpmMsg = formatPackNpmWarning(packNpmWarning);
+  if (packNpmMsg) {
+    return Promise.reject(packNpmMsg);
+  }
+
+  return Promise.resolve();
+};
+
+
+module.exports = {
+  buildMpNpm,
+};

package/src/core/npm.js

@@ -0,0 +1,218 @@
+/**
+ * 本文件主要负责项目或者分包依赖的npm的安装
+ */
+const fs = require('fs');
+const fsExtra = require('fs-extra');
+const crypto = require('crypto');
+const path = require('path');
+const shell = require('shelljs');
+const glob = require('glob-ignore');
+const log = require('../utils/log');
+const { npmInstall } = require('../utils/widgets');
+const { handleError } = require('./handleError');
+const { info } = require('console');
+
+const shellJsOption = { async: false, silent: true };
+const dirPath = process.cwd(); // 项目根目录
+
+const collectNpmTasksMap = (packageJsonFiles, cacheDir) => {
+  // 下载代码任务 Map (key解释 缓存代码路径/md5(package.json.dependencies)
+  // {
+  // '/Users/odile/.tmskit/node_modules/026cb72509c2369dbd75779181f820bc': {
+  //   promiseTask, 下载的任务
+  //   params: { 下载代码时的参数
+  //       gitUrl,
+  //       sourcePath,
+  //       branch,
+  //   },
+  //   callbacks: [callback],// 下载完代码后的回调
+  //  }
+  // }
+  const npmTasksMap = new Map();
+  for (const packageJsonPath of packageJsonFiles) {
+    const packageContent = fs.readFileSync(packageJsonPath);
+    const packageJson = JSON.parse(packageContent);
+    const md5Obj = {
+      dependencies: packageJson.dependencies || {},
+    };
+
+    if (Object.keys(md5Obj.dependencies).length !== 0) {
+      const md5Key = crypto.createHash('md5').update(JSON.stringify(md5Obj))
+        .digest('hex');
+      const cacheNMPath = path.join(cacheDir, md5Key);
+      const cacheNMTarFile = path.join(cacheNMPath, 'node_modules.tar.gz');
+
+      // 下载后，添加回调函数 (拷贝node_modules.tar.gz到编译目录并解压)
+      const callback = {
+        params: { cacheNMPath, cacheNMTarFile,  packageJsonDir: path.dirname(packageJsonPath), shell },
+        fn: async (cacheNMPath, cacheNMTarFile, packageJsonDir, shell) => {
+          shell.cd(cacheNMPath);
+          shell.cp('-Rf', cacheNMTarFile, `${packageJsonDir}/`);
+          const newShellJsOption = {
+            ...shellJsOption,
+            cwd: packageJsonDir,
+          };
+          shell.exec('tar -xzvf ./node_modules.tar.gz -C ./',  newShellJsOption);
+          shell.exec('rm -rf ./node_modules.tar.gz', newShellJsOption);
+        },
+      };
+
+      if (npmTasksMap.has(cacheNMPath)) {
+        const task = npmTasksMap.get(cacheNMPath);
+        task.callbacks.push(callback);
+        npmTasksMap.set(cacheNMPath, task);
+      } else {
+        const missCache = !fsExtra.pathExistsSync(cacheNMPath)
+             || !fsExtra.existsSync(cacheNMTarFile)
+             || fsExtra.statSync(cacheNMTarFile).size < 512;
+        let promiseTask = () => Promise.resolve();
+        if (missCache) {
+          promiseTask = (packageJsonPath, cacheNMPath, shell) => {
+            fsExtra.emptydirSync(cacheNMPath);
+            shell.cp('-f', packageJsonPath, cacheNMPath);
+            info(`npm install: ${packageJsonPath}`);
+            return npmInstall(cacheNMPath).then(() => {
+              const newShellJsOption = {
+                ...shellJsOption,
+                cwd: cacheNMPath,
+              };
+              shell.exec('tar -zcvf ./node_modules.tar.gz ./node_modules', newShellJsOption);
+              shell.exec('rm -rf ./node_modules', newShellJsOption);
+            });
+          };
+        }
+        npmTasksMap.set(cacheNMPath, {
+          promiseTask,
+          params: {
+            packageJsonPath,
+            cacheNMPath,
+            shell,
+          },
+          callbacks: [callback],
+        });
+      }
+    }
+  }
+  return npmTasksMap;
+};
+
+
+// 遍历安装指定目录下所有项目的npm依赖
+const mpNpmInstallAll = async (modules, contextDir, cacheDir) => {
+  const packageJsonFiles = await findAllPackageJson(modules, contextDir);
+
+  // 收集npm install的任务
+  const npmTasksMap = collectNpmTasksMap(packageJsonFiles, cacheDir);
+
+  // 开始执行npm install和回调（移动）的任务
+  const arrPromises = [];
+  npmTasksMap.forEach(({ promiseTask, params, callbacks }) => {
+    arrPromises.push(promiseTask(...Object.keys(params).map(key => params[key]))
+      .then(async () => {
+        const callArr = callbacks.map(async ({
+          params: cParams,
+          fn,
+        }) => fn(...Object.keys(cParams).map(key => cParams[key])));
+        return Promise.all(callArr);
+      })
+      .catch((e) => {
+        handleError(`npm install ${params.packageJsonPath}出现错误：${e}`);
+      }));
+  });
+
+  await Promise.all(arrPromises);
+};
+
+/**
+  * 递归查找指定条件的文件
+  * @param {String} startPath 开始查找的根路径
+  * @param {String} filter 匹配的字符串
+  * @returns {Array<String>} 查找到的文件路径列表
+  */
+const findFilesByFilter = (startPath, filter) => {
+  const result = [];
+  /**
+    * 根据指定的筛选器查找文件
+    * @param {String} startPath 开始查找的文件夹路径
+    * @param {String} filter 筛选器
+    * @returns {Undefined} 无需返回值
+    */
+  const find = (startPath, filter) => {
+    // 目录不存在
+    if (!fs.existsSync(startPath)) {
+      log.fail(`${startPath}目录不存在`);
+      process.exit(-1);
+      return;
+    }
+
+    // 当前目录下的所有文件 / 文件夹
+    const exceptDir = ['node_modules', 'miniprogram_npm'];
+    if (exceptDir.find(item => startPath.indexOf(item) > -1)) {
+      return;
+    }
+    const files = fs.readdirSync(startPath);
+    files.forEach((file) => {
+      const filename = path.join(startPath, file);
+      const stat = fs.lstatSync(filename);
+      // 当前文件是文件夹类型，继续递归
+      if (stat.isDirectory()) {
+        find(filename, filter);
+      } else if (filename.indexOf(filter) >= 0) {
+        // 文件类型
+        result.push(filename);
+      };
+    });
+  };
+
+  find(startPath, filter);
+  return result;
+};
+
+/**
+  * 找到项目中所有的package.json文件
+  * @param {Array<String>} subRoots 需要安装npm依赖的路径
+  * @param {String} contextDir 命令运行的目录
+  * @returns {Array<String>} 找到的所有package.json文件的路径
+  */
+const findAllPackageJson = (subRoots = [], contextDir) => {
+  const packageJsonName = 'package.json';         // 查找文件名
+  const cwd = contextDir || dirPath;
+  const result = [path.join(cwd, packageJsonName)]; // 默认填充根目录下的package.json
+
+  subRoots.forEach((subRoot) => {
+    if (!subRoot.root) {
+      log.fail(`请检查${subRoot.name}的module.config.json是否有root字段`);
+      process.exit(1);
+    }
+    const toppath = path.join(cwd, subRoot.root); // 从该目录开始查找package.json文件
+    const list = findFilesByFilter(toppath, packageJsonName);
+
+    result.push(...list);
+  });
+
+  return result;
+};
+
+function cloudNpmInstall(contextDir) {
+  return new Promise((resolve, reject) => {
+    glob(`${contextDir}/**/package.json`, ['node_modules', 'miniprogram_npm'], (err, files) => {
+      if (err) {
+        reject(err);
+      }
+      files.forEach((file) => {
+        const dir = path.dirname(file);
+        shell.cd(dir);
+        shell.exec('npx npm install --production --registry http://mirrors.tencent.com/npm/', { silent: false });
+      });
+      resolve();
+    });
+  });
+}
+
+
+module.exports = {
+  cloudNpmInstall,
+  mpNpmInstallAll,
+  findAllPackageJson,
+};
+

package/src/core/symbolicLink.js

@@ -0,0 +1,24 @@
+const fs = require('fs');
+const { resolve } = require('../utils/widgets');
+const { handleError } = require('./handleError');
+const { DEFAULT_CLOUD_MODULE_DIR } = require('../config/constant');
+
+/**
+ * 根据相关配置创建软链接
+ * @param { object } tmsConfig
+ */
+const symLink = (tmsConfig) => {
+  try {
+    if (tmsConfig.cloudModules) {
+      tmsConfig.cloudModules.forEach((item) => {
+        fs.symlinkSync(resolve(item.path), resolve(DEFAULT_CLOUD_MODULE_DIR, item.name));
+      });
+    }
+  } catch (e) {
+    handleError(`创建软链错误: ${e}`);
+  }
+};
+
+module.exports = {
+  symLink,
+};