@tmsfe/tmskit 0.0.17 → 0.0.20

package/src/scripts/run/index.js

@@ -1,15 +1,18 @@
+/* eslint-disable no-param-reassign */
+const loadash = require('lodash');
 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 { fail, info } = require('../../utils/log');
 const { global } = require('../../utils/global');
 const {
   readTmsConfig,
   readTmsPrivateCf,
   checkModules,
-  tmsModulesMergeLocalModuleCfg,
-  subModulesMergeDepModules,
+  getModulesByMergeDepModules,
+  getSubPackages,
 } = require('../../core/tmsMpconfig');
 
 const handleModuleArg = (cmd) => {
@@ -25,81 +28,109 @@ const handleModuleArg = (cmd) => {
  * @param {Object} modulePrivateCfg 私有配置里的模块
  * @param {Array} moduleAll 当前小程序全部模块
  */
-const getSpecificModules = (moduleArg, modulePrivateCfg, moduleAll) => {
+const getSpecificModules = (moduleArg, modules) => {
   if (moduleArg.length > 0) {
     return moduleArg;
   }
+  const { all, include, exclude, blockRemote } = modules;
   // 单模块或多模块开发-用户在tms.private.js指定的模块
-  if (modulePrivateCfg) {
-    if (modulePrivateCfg.include?.length > 0) {
-      return modulePrivateCfg.include;
-    }
-    if (modulePrivateCfg.exclude?.length > 0) {
-      return moduleAll.filter(module => !modulePrivateCfg.exclude.includes(module.name)).map(item => item.name);
-    }
-    if (modulePrivateCfg.blockRemote === true) {
-      return moduleAll.filter(module => module.repoInfo === undefined).map(item => item.name);
-    }
+  if (include?.length > 0) {
+    return include;
+  }
+  if (exclude?.length > 0) {
+    return all.filter(module => !exclude.includes(module.moduleName)).map(item => item.moduleName);
+  }
+  if (blockRemote === true) {
+    return all.filter(module => module.repoInfo === undefined).map(item => item.moduleName);
+  }
+  return all.map(item => item.moduleName);
+};
+
+/**
+ * 合并tms.config.js 与 tms.private.config.js的配置项
+ * @param {*} tmsConfig
+ * @param {*} tmsPrivateCf
+ * @returns
+ */
+const mergeConfig = (tmsConfig, tmsPrivateCf) => {
+  const modules = {};
+  if (Array.isArray(tmsConfig.modules)) {
+    modules.all = tmsConfig.modules;
+    tmsConfig.modules = modules;
   }
-  return moduleAll.map(item => item.name);
+  // 合并默认值
+  const res = loadash.mergeWith(tmsConfig, tmsPrivateCf, (objValue, srcValue) => {
+    if (loadash.isArray(objValue) && objValue[0] && loadash.isObject(objValue[0])) {
+      return objValue.concat(srcValue);
+    }
+  });
+
+  return res;
 };
 
 async function run(commandName, cmd) {
-  // 用户本地的私有项目配置（用来配置环境\模块信息\账号信息）
-  const tmsPrivateCf = readTmsPrivateCf();
-  const { env = tmsPrivateCf?.env } = cmd;
-  const tmsConfig = readTmsConfig(env);
-  // 处理module参数
-  const specificModules = getSpecificModules(
-    handleModuleArg(cmd),
-    tmsPrivateCf.modules,
-    tmsConfig.modules,
-  );
+  try {
+  // 用户本地的私有项目配置
+    const tmsPrivateCf = readTmsPrivateCf();
+    const { env = tmsPrivateCf?.env } = cmd;
+    let tmsConfig = readTmsConfig(env);
+    tmsConfig = mergeConfig(tmsConfig, tmsPrivateCf);
 
-  const modules = checkModules(
-    tmsConfig,
-    [
-      ...new Set([
-        ...tmsConfig.mainPackages,
-        ...specificModules,
-      ]),
-    ],
-    true,
-  );
+    // 处理module参数
+    const specificModules = getSpecificModules(
+      handleModuleArg(cmd),
+      tmsConfig.modules,
+    );
 
-  // tms.config.js的modules 合并 module.config.json的配置项
-  let newModules = tmsModulesMergeLocalModuleCfg(modules, tmsConfig.appName);
-  // A分包依赖了B分包的代码， merge B分包进行编译；
-  newModules = subModulesMergeDepModules(tmsConfig, newModules);
+    const modules = checkModules(
+      tmsConfig,
+      [
+        ...new Set([
+          ...tmsConfig.mainPackages,
+          ...specificModules,
+        ]),
+      ],
+      true,
+    );
 
-  // 缓存数据
-  global.setData({
-    env,
-    cmd,
-    tmsPrivateCf,
-    tmsConfig,
-  });
+    // 获取所有模块，合并模块依赖的模块
+    const newModules = getModulesByMergeDepModules(tmsConfig, modules);
+    // 获取所有的分包
+    const subPackages = getSubPackages(newModules);
 
-  switch (commandName) {
-    case 'init':
-      init(tmsConfig, newModules, env);
-      return;
-    case 'dev':
-      global.setData('isDev', true);
-      dev(tmsConfig, newModules, env);
-      return;
-    case 'cloud':
-      cloud(tmsConfig, env);
-      return;
-    case 'install':
-      install(tmsConfig, newModules, env);
-      return;
-    case 'build':
-      global.setData('isDev', false);
-      build(tmsConfig, newModules, env);
-      return;
-    default:
-      return;
+    // 缓存数据
+    global.setData({
+      env,
+      cmd,
+      tmsConfig,
+    });
+
+    switch (commandName) {
+      case 'init':
+        init(tmsConfig, newModules);
+        return;
+      case 'dev':
+        global.setData('isDev', true);
+        dev(tmsConfig, newModules);
+        return;
+      case 'cloud':
+        cloud(tmsConfig);
+        return;
+      case 'install':
+        install(tmsConfig, subPackages, false);
+        return;
+      case 'build':
+        global.setData('isDev', false);
+        build(tmsConfig, newModules);
+        return;
+      default:
+        return;
+    }
+  } catch (error) {
+    const errMsg = typeof error === 'object' ? error.message : error;
+    fail(`构建出现错误: ${errMsg}`);
+    info('详细错误信息', error);
+    process.exit(1);
   }
 }
 

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

@@ -5,10 +5,9 @@ const { resolve, createTask } = require('../../../utils/widgets');
 const { buildOutputAppJson } = require('../../../core/buildAppJson');
 const { MODULE_CODE_DIR, DEFAULT_COPY_CONFIG } = require('../../../config/constant');
 const { cloneModules } = require('../../../core/cloneModules');
-const { tmsModulesMergeLocalModuleCfg, subModulesMergeDepModules } = require('../../../core/tmsMpconfig');
+const { getModulesByMergeDepModules, getSubPackages } = require('../../../core/tmsMpconfig');
 const { fail, info } = require('../../../utils/log');
 const install = require('../install');
-const { checkDependencies } = require('../../../core/checkDependencies');
 
 /**
  * 拷贝相关配置文件到编译输出目录
@@ -54,12 +53,12 @@ async function task(tmsConfig, targetModules) {
     '下载模块代码码完成',
   )(MODULE_CODE_DIR, resolve('./'), targetModules);
 
-  // tms.config.js的modules 合并 module.config.json的配置项
-  let newModules = tmsModulesMergeLocalModuleCfg(targetModules, tmsConfig.appName);
-  // A分包依赖了B分包的代码， merge B分包进行编译；
-  newModules = subModulesMergeDepModules(tmsConfig, newModules);
+  // 获取所有模块，合并模块依赖的模块
+  const newModules = getModulesByMergeDepModules(tmsConfig, targetModules, true);
+  // 获取所有的分包
+  const newSubPackages = getSubPackages(newModules);
 
-  checkConfig(newModules);
+  checkConfig(newSubPackages);
 
   // 拷贝相关配置文件到输出目录
   await createTask(
@@ -69,9 +68,8 @@ async function task(tmsConfig, targetModules) {
   )(tmsConfig, DEFAULT_COPY_CONFIG);
 
   // install
-  if (checkDependencies(newModules, resolve('./'), tmsConfig.outputDir)) {
-    await install(tmsConfig, newModules);
-  }
+  await install(tmsConfig, newSubPackages);
+
 
   // 动态生成编译后的app.json;
   await createTask(
@@ -80,15 +78,16 @@ async function task(tmsConfig, targetModules) {
     '生成编译后的app.json完成',
   )(tmsConfig, newModules);
 
-  return newModules;
+  return {
+    modules: newModules,
+    subPackages: newSubPackages,
+  };
 }
 async function init(tmsConfig, targetModules) {
   try {
-    const newModules = await task(tmsConfig, targetModules);
+    const taskRes = await task(tmsConfig, targetModules);
 
-    return {
-      targetModules: newModules,
-    };
+    return taskRes;
   } catch (error) {
     const errMsg = typeof error === 'object' ? error.message : error;
     fail(`初始化流程出现错误${errMsg}`);

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

@@ -1,14 +1,49 @@
 const shelljs = require('shelljs');
 const fs = require('fs');
+const path = require('path');
 const io = require('../../../utils/io');
 const { createTask, resolve } = require('../../../utils/widgets');
 const { buildMpNpm } = require('../../../core/mpCi');
+const { setCache, getCache } = require('../../../core/cache');
 const { CACHE_DIR } = require('../../../config/constant');
-const { mpNpmInstallAll } = require('../../../core/npm');
-const { global } = require('../../../utils/global');
-const { fail } = require('../../../utils/log');
+const { npmInstallAll } = require('../../../core/npm');
+const { fail, info } = require('../../../utils/log');
+const { fileMd5 } = require('../../../utils/md5');
+const { isDependenciesUpdate } = require('../../../core/checkDependencies');
 
-async function install(tmsConfig, modules) {
+async function install(tmsConfig, modules, useCache = true) {
+  const cwd = process.cwd();
+  const npmInstallRes = await createTask(
+    npmInstall,
+    '小程序 开始npm install',
+    '小程序npm install 完成',
+  )(tmsConfig, modules, useCache);
+
+  // 如果npm install 没有命中缓存，则说明node_module有更新，此时必须构建miniprogram_npm
+  if (!npmInstallRes.isCache) {
+    // 构建miniprogram_npm, 不使用缓存
+    await createTask(
+      mpCiInstall,
+      '开始构建miniprogram_npm',
+      '构建miniprogram_npm 完成',
+    )(tmsConfig, modules, false);
+  } else {
+    // 构建miniprogram_npm
+    await createTask(
+      mpCiInstall,
+      '开始构建miniprogram_npm',
+      '构建miniprogram_npm 完成',
+    )(tmsConfig, modules, useCache);
+  }
+  shelljs.cd(cwd);
+}
+
+async function npmInstall(tmsConfig, modules, useCache) {
+  // 如果依赖没有更新和使用缓存数据（则命中缓存）
+  if (!isDependenciesUpdate(modules, resolve('./'), tmsConfig.outputDir) && useCache) {
+    info('node_modules命中缓存');
+    return { isCache: true };
+  }
   // 拷贝模块的package.json到编译输出目录
   modules.forEach((item) => {
     const outputModuleDir = resolve(`${tmsConfig.outputDir}/${item.root}`);
@@ -21,20 +56,77 @@ async function install(tmsConfig, modules) {
     if (fs.existsSync(modulePackagePath)) shelljs.cp('-Rf', modulePackagePath, outputModuleDir);
   });
 
-  // 小程序npm install
-  await createTask(
-    mpNpmInstallAll,
-    '小程序 开始npm install',
-    '小程序npm install 完成',
-  )(modules, resolve(tmsConfig.outputDir), `${CACHE_DIR}/node_modules`);
-
-  const tmsPrivateCf = global.getData('tmsPrivateCf');
-  // 构建miniprogram_npm
-  await createTask(
-    buildMpNpm,
-    '开始构建miniprogram_npm',
-    '构建miniprogram_npm 完成',
-  )({ appId: tmsConfig.appId, projectPath: resolve('./'), privateKey: tmsPrivateCf.privateKey });
+  await npmInstallAll(modules, resolve(tmsConfig.outputDir), `${CACHE_DIR}/node_modules`);
+  return { isCache: false };
+}
+
+// 构建miniprogram_npm
+async function mpCiInstall(tmsConfig, modules, useCache) {
+  const packageJsonFiles = [];
+  const rootPackFile = resolve(`${tmsConfig.outputDir}/package.json`);
+  if (fs.existsSync(rootPackFile)) {
+    packageJsonFiles.push(rootPackFile);
+  }
+  modules.forEach((item) => {
+    const packageJsonFile = resolve(`${tmsConfig.outputDir}/${item.root}/package.json`);
+    if (fs.existsSync(packageJsonFile)) {
+      packageJsonFiles.push(packageJsonFile);
+    }
+  });
+
+  let isCache = false;
+  const statusMap = { success: 1, doing: 2 };
+  if (useCache) {
+    let flag = true;
+    await Promise.all(packageJsonFiles.map(async (item) => {
+      const packageDir = path.dirname(item);
+      const mpDir = resolve(`${packageDir}/miniprogram_npm`);
+      const md5Value = await getMNPMd5(packageDir);
+      const preCache = getCache(mpDir, 'miniprogram_npm');
+      // console.log('miniprogram_npm', preCache, md5Value);
+      // 上一次构建成功 && 上次md5与当前本地的miniprogram_npm的md5 一致，才可以进入缓存
+      if (preCache?.status !== statusMap.success || preCache?.md5 !== md5Value) {
+        flag = false;
+      }
+    }));
+    isCache = flag;
+  }
+
+  if (isCache) {
+    info('miniprogram_npm命中缓存');
+    return;
+  }
+
+  // 即将构建，在cache中标记开始
+  await Promise.all(packageJsonFiles.map(async (item) => {
+    const packageDir = path.dirname(item);
+    const mpDir = resolve(`${packageDir}/miniprogram_npm`);
+    setCache(mpDir, 'miniprogram_npm', { md5: '', status: statusMap.doing });
+  }));
+
+  await buildMpNpm({ appId: tmsConfig.appId, projectPath: resolve('./'), privateKey: tmsConfig.privateKey });
+
+  // 构建成功后，计算md5写入cache
+  await Promise.all(packageJsonFiles.map(async (item) => {
+    const packageDir = path.dirname(item);
+    const mpDir = resolve(`${packageDir}/miniprogram_npm`);
+    const md5Value = await getMNPMd5(packageDir);
+    setCache(mpDir, 'miniprogram_npm', { md5: md5Value, status: statusMap.success });
+  }));
+}
+
+// 计算miniprogram_npm压缩文件的md5值
+async function getMNPMd5(cwd) {
+  const shellJsOption = { async: false, silent: true };
+  shelljs.cd(cwd);
+  if (fs.existsSync('miniprogram_npm')) {
+    shelljs.exec('tar -cvf ./miniprogram_npm.tar.gz ./miniprogram_npm',  { cwd, ...shellJsOption });
+    const tarDir = path.join(cwd, './miniprogram_npm.tar.gz');
+    const md5Value = await fileMd5(tarDir);
+    shelljs.rm('-rf', tarDir);
+    return md5Value;
+  }
+  return '';
 }
 
 module.exports = install;

package/src/utils/md5.js

@@ -0,0 +1,25 @@
+const crypto = require('crypto');
+const fs = require('fs');
+
+function fileMd5(filePath) {
+  return new Promise((resolve, reject) => {
+    const md5sum = crypto.createHash('md5');
+    const stream = fs.ReadStream(filePath);
+    stream.on('data', (d) => {
+      md5sum.update(d);
+    });
+
+    stream.on('error', (err) => {
+      reject(err);
+    });
+
+    stream.on('end', () => {
+      const hash = md5sum.digest('hex');
+      resolve(hash);
+    });
+  });
+}
+
+module.exports = {
+  fileMd5,
+};

package/src/utils/widgets.js

@@ -5,6 +5,7 @@ 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 };
@@ -180,6 +181,34 @@ const relativeCwdPath = function (file) {
   return path.relative(process.cwd(), file);
 };
 
+/**
+ * 从一个对象中，检索出去几个字段
+ * @param {*} obj
+ * @param {*} name
+ * @returns
+ */
+const filterField = (obj, filterNames = []) => {
+  const newObj = { ...obj };
+  filterNames.forEach((name) => {
+    if (newObj[name]) {
+      delete newObj[name];
+    }
+  });
+  return newObj;
+};
+
+// 检索出文件列表
+function findFiles(globPath, filter = []) {
+  return new Promise((resolve, reject) => {
+    glob(globPath, filter, (err, files) => {
+      if (err) {
+        reject(err);
+      }
+      resolve(files);
+    });
+  });
+}
+
 module.exports = {
   resolve,
   isObject,
@@ -192,4 +221,6 @@ module.exports = {
   npmInstall,
   mergeMap,
   relativeCwdPath,
+  filterField,
+  findFiles,
 };

package/src/core/isInIt.js

@@ -1,65 +0,0 @@
-const fs = require('fs');
-const { resolve } = require('../utils/widgets');
-const { MODULE_CODE_DIR } = require('../config/constant');
-const { checkRemoteModGitUrlBranch } = require('./cloneModules');
-const { checkDependencies } = require('./checkDependencies');
-const { fail } = require('../utils/log');
-
-function checkModule(targetModules) {
-  // 判断\源码\dist\是否存在用户指定的模块
-  for (const item of targetModules) {
-    // 此模块没有root字段(原因：没有merge到module.config.json的配置项。第三方模块的代码可能还没有下载)
-    if (!item.root) {
-      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,
-};