@tmsfe/tmskit 0.0.18 → 0.0.19

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tmsfe/tmskit",
-  "version": "0.0.18",
+  "version": "0.0.19",
   "description": "tmskit",
   "main": "dist/index.cjs",
   "bin": {

package/src/config/constant.js

@@ -7,6 +7,9 @@ const HOME_DIR = os.homedir();
 // 所有文件的缓存目录
 const CACHE_DIR = path.resolve(HOME_DIR, '.tmskit');
 
+// 缓存文件
+const  CACHE_FILE = 'cache_file.json';
+
 // 脚手架模板代码所在目录
 const TEMPLATE_DIR = path.resolve(CACHE_DIR, 'template');
 
@@ -48,9 +51,11 @@ const ENV = {
 
 const  TEMPLATE_TKIT_DIR = '_tmskit';
 
+
 export {
   HOME_DIR,
   CACHE_DIR,
+  CACHE_FILE,
   TEMPLATE_DIR,
   TEMPLATE_PATH,
   TMS_NAME,

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/checkDependencies.js

@@ -17,7 +17,7 @@ const getLatestVersion = (npmName) => {
  * @param {*} outputDir  待检查node_modules存放的目录 （eg: dist/node_modules）
  * @returns
  */
-const checkDependencies = (modules, cwd, outputDir) => {
+const isDependenciesUpdate = (modules, cwd, outputDir) => {
   // 步骤1. 收集package.json
   const packageJsonName = 'package.json';  // 查找文件名
   // 1.1根目录的package.json
@@ -73,5 +73,5 @@ const checkDependencies = (modules, cwd, outputDir) => {
 };
 
 module.exports = {
-  checkDependencies,
+  isDependenciesUpdate,
 };

package/src/core/npm.js

@@ -99,7 +99,7 @@ const collectNpmTasksMap = (packageJsonFiles, cacheDir) => {
 
 
 // 遍历安装指定目录下所有项目的npm依赖
-const mpNpmInstallAll = async (modules, contextDir, cacheDir) => {
+const npmInstallAll = async (modules, contextDir, cacheDir) => {
   const cwd = process.cwd();
   const packageJsonFiles = await findAllPackageJson(modules, contextDir);
 
@@ -124,6 +124,7 @@ const mpNpmInstallAll = async (modules, contextDir, cacheDir) => {
 
   await Promise.all(arrPromises);
   shell.cd(cwd);
+  return packageJsonFiles;
 };
 
 /**
@@ -215,7 +216,7 @@ function cloudNpmInstall(contextDir) {
 
 module.exports = {
   cloudNpmInstall,
-  mpNpmInstallAll,
+  npmInstallAll,
   findAllPackageJson,
 };
 

package/src/core/tmsMpconfig.js

@@ -22,10 +22,9 @@ const readTmsConfig = function (env) {
   const tmsConfig = tmsConfigFn({
     env,
   });
-  // 合并默认值
-  loadash.mergeWith(tmsConfig, defaultTmsConfig);
 
-  return tmsConfig;
+  // 合并默认值
+  return loadash.mergeWith(defaultTmsConfig, tmsConfig);
 };
 
 

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

@@ -14,7 +14,7 @@ function delOtherModule(tmsConfig, targetModules) {
   const targetModulesName = targetModules.map(item => item.name);
   modules.forEach((item) => {
     if (item.root && targetModulesName.indexOf(item.name) === -1) {
-      const moduleRootDir = resolve(`dist/${item.root}`);
+      const moduleRootDir = resolve(`${tmsConfig.outputDir}/${item.root}`);
       shelljs.rm('-rf', `${moduleRootDir}/*`, { silent: true });
       // 解决微信开发者工具（dist/app.json: ["subpackages"][0]["root"] 字段需为 目录）错误 - 提前创建该目录
       // io.ensureDirExist(moduleRootDir);

package/src/scripts/run/index.js

@@ -109,7 +109,7 @@ async function run(commandName, cmd) {
       cloud(tmsConfig, env);
       return;
     case 'install':
-      install(tmsConfig, newModules, env);
+      install(tmsConfig, newModules, env, false);
       return;
     case 'build':
       global.setData('isDev', false);

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

@@ -8,7 +8,6 @@ const { cloneModules } = require('../../../core/cloneModules');
 const { tmsModulesMergeLocalModuleCfg, subModulesMergeDepModules } = require('../../../core/tmsMpconfig');
 const { fail, info } = require('../../../utils/log');
 const install = require('../install');
-const { checkDependencies } = require('../../../core/checkDependencies');
 
 /**
  * 拷贝相关配置文件到编译输出目录
@@ -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, newModules);
+
 
   // 动态生成编译后的app.json;
   await createTask(

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

@@ -1,13 +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 { 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, env, 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}`);
@@ -20,19 +56,76 @@ 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`);
-
-  // 构建miniprogram_npm
-  await createTask(
-    buildMpNpm,
-    '开始构建miniprogram_npm',
-    '构建miniprogram_npm 完成',
-  )({ appId: tmsConfig.appId, projectPath: resolve('./'), privateKey: tmsConfig.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 md5Value = await fileMd5('./miniprogram_npm.tar.gz');
+    shelljs.rm('-rf', path.join(cwd, './miniprogram_npm.tar.gz'));
+    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 };
@@ -196,6 +197,18 @@ const filterField = (obj, filterNames = []) => {
   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,
@@ -209,4 +222,5 @@ module.exports = {
   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,
-};