@tmsfe/tmskit 0.0.6 → 0.0.9-beta.0

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/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,
+};

package/src/{utils/tkitUtils.js → core/tmsMpconfig.js}

@@ -1,10 +1,12 @@
+/**
+ * 用来读取处理tms.config.js与module.config.json字段
+ */
 const loadash = require('lodash');
 const fs = require('fs');
 const { TMS_NAME, TMS_CONFIG_FILENAME, MODULE_CONFIG_FILENAME, TMS_PRIVATE_FILENAME } = require('../config/constant');
-const { resolve, isObject } = require('./widgets');
-const { setModuleConfig, getValidModules } = require('./buildAppJson');
+const { resolve, isObject, isArray } = require('../utils/widgets');
 const defaultTmsConfig = require('../config/defaultTmsConfig');
-const { fail } = require('./log');
+const { fail } = require('../utils/log');
 const path = require('path');
 
 /**
@@ -23,6 +25,7 @@ const readTmsConfig = function (env) {
   });
   // 合并默认值
   loadash.mergeWith(tmsConfig, defaultTmsConfig);
+
   // modules兼容处理
   tmsConfig.modules = convertModules(tmsConfig.modules);
   return tmsConfig;
@@ -31,7 +34,7 @@ const readTmsConfig = function (env) {
 // convertModules 处理默认值
 const convertModules = (modules) => {
   const newModules = [];
-  modules.forEach((module, index) => {
+  modules.forEach((module) => {
     const newModule = {};
     if (typeof module === 'string') {
       // 路径字符串
@@ -51,15 +54,21 @@ const convertModules = (modules) => {
 };
 
 /**
- * 读取tms.private.js
+ * 读取tms.private.config.js
  */
 const readTmsPrivateCf = function () {
-  let tmsPrivateCg;
+  let tmsPrivateCf = {};
   const tmsPrivatePath = resolve(TMS_PRIVATE_FILENAME);
   if (fs.existsSync(tmsPrivatePath)) {
-    tmsPrivateCg = require(tmsPrivatePath);
+    tmsPrivateCf = require(tmsPrivatePath);
   }
-  return tmsPrivateCg;
+  // 处理modules字段
+  if (tmsPrivateCf.modules instanceof Array) {
+    Object.assign(tmsPrivateCf.modules, {
+      include: tmsPrivateCf.modules,
+    });
+  }
+  return tmsPrivateCf;
 };
 
 /**
@@ -81,6 +90,64 @@ const checkModules = function (tmsConfig, modules) {
   return targetModules;
 };
 
+/**
+ * 过滤页面为空的分包
+ * @param {Array} moduleCfg 模块配置内容
+ * @returns pages不为空的分包
+ */
+const getValidModules = (moduleCfg) => {
+  // 过滤 pages 为空的情况
+  const validModules = moduleCfg.filter(item => item.pages.length > 0);
+  return validModules;
+};
+
+/**
+ * 适配处理module.config.json的字段
+ * @param { object } fileContent module.config.json的内容
+ * @param { string } appName 小程序的名称
+ */
+function adaptMpCgContent(fileContent, appName) {
+  const content = fileContent.contents ? JSON.parse(fileContent.contents.toString()) : JSON.parse(fileContent);
+
+  if (isArray(content)) {
+    let i = content.length - 1;
+    while (i >= 0) {
+      let current = content[i];
+
+      if (appName && current.mpConfig && current.mpConfig[appName]) {
+        current = { ...current, ...current.mpConfig[appName] };
+      }
+
+      delete current.mpConfig;
+      delete current.isSubpackages;
+
+      content[i] = current;
+      i--; // eslint-disable-line
+    }
+  }
+  return content;
+}
+
+/**
+ * 递归获取本地所有模块的配置信息
+ * @param {array} modules 用户要编译的模块列表
+ * @param { string } appName 小程序的名称
+ * @param { string } moduleConfigFilename moduleConfig的文件名
+ */
+function getModuleConfig(modules = [], appName, moduleConfigFilename) {
+  const modulesConfig = {};
+
+  modules.forEach(({ path }) => {
+    const moduleConfigPath = resolve(path, moduleConfigFilename);
+    if (fs.existsSync(moduleConfigPath)) {
+      const content = fs.readFileSync(moduleConfigPath, 'utf-8');
+      modulesConfig[moduleConfigPath] = adaptMpCgContent(content, appName);
+    }
+  });
+
+  return modulesConfig;
+}
+
 /**
  * tms.config.js的modules 合并 module.config.json的配置项
  * @param {array} modules
@@ -94,17 +161,23 @@ const tmsModulesMergeLocalModuleCfg = (modules, appName) => {
     const moduleConfigPath = resolve(relativePath, MODULE_CONFIG_FILENAME);
     if (fs.existsSync(moduleConfigPath)) {
       try {
+        let findModule = false;
         let moduleConfigContent = fs.readFileSync(moduleConfigPath, 'utf-8');
-        moduleConfigContent = setModuleConfig(moduleConfigContent, appName);
+        moduleConfigContent = adaptMpCgContent(moduleConfigContent, appName);
         const moduleContentArr = isObject(moduleConfigContent) ? [moduleConfigContent] : moduleConfigContent;
         getValidModules(moduleContentArr).forEach(({ name }, moduleContentArrIndex) => {
           if (name === moduleName) {
+            findModule = true;
             newModules.push({
               ...modules[moduleIndex],
               ...moduleContentArr[moduleContentArrIndex],
             });
           }
         });
+        if (!findModule) {
+          fail(`启动模块${moduleName}在${moduleConfigPath}没有找到，请检查配置`);
+          process.exit(1);
+        }
       } catch (e) {
         fail(`${moduleConfigPath}配置错误: ${e}`);
         newModules.push({
@@ -134,6 +207,7 @@ const subModulesMergeDepModules = (tmsConfig, modules) => {
   });
   let mergeModules = modules;
   let isOver = true;
+
   modules.forEach(({ dependencies: dependencyModules }) => {
     dependencyModules?.forEach((item) => {
       // 如果所有模块的dep都在moduleNames内，则所有依赖都齐了
@@ -152,6 +226,8 @@ const subModulesMergeDepModules = (tmsConfig, modules) => {
 module.exports = {
   readTmsConfig,
   readTmsPrivateCf,
+  getModuleConfig,
+  getValidModules,
   checkModules,
   tmsModulesMergeLocalModuleCfg,
   subModulesMergeDepModules,

package/src/entry.js

@@ -28,6 +28,7 @@ module.exports = [
         options: [
           ['-m, --module [moduleName]', '模块名称'],
           ['-e, --env [env]', '环境变量'],
+          ['-latest, --latest', '下载最新第三方模块代码、安装最新依赖'],
         ],
         action: (cmd) => {
           require('./scripts/run/index')('dev', cmd);
@@ -44,17 +45,18 @@ module.exports = [
           require('./scripts/run/index')('build', cmd);
         },
       },
-      {
-        command: 'init',
-        description: '根据模块配置初始化项目(eg: 动态拷贝模块、下载依赖、生成app.json等)',
-        options: [
-          ['-m, --module [moduleName]', '模块名称'],
-          ['-e, --env [env]', '环境变量'],
-        ],
-        action: (cmd) => {
-          require('./scripts/run/index')('init', cmd);
-        },
-      },
+      // 对外暂不暴露该命令
+      // {
+      //   command: 'init',
+      //   description: '模块配置初始化项目(eg: 下载第三方模块代码、安装依赖、生成app.json等)',
+      //   options: [
+      //     ['-m, --module [moduleName]', '模块名称'],
+      //     ['-e, --env [env]', '环境变量'],
+      //   ],
+      //   action: (cmd) => {
+      //     require('./scripts/run/index')('init', cmd);
+      //   },
+      // },
     ],
   },
 ];

package/src/index.js

@@ -1,6 +1,7 @@
 const chalk = require('chalk');
 const commander = require('commander');
-const { log, suggestCommands } = require('./utils/widgets');
+const { suggestCommands } = require('./utils/widgets');
+const { info } = require('./utils/log');
 const { TMS_NAME } = require('./config/constant.js');
 const commands = require('./entry');
 const init = require('./init');
@@ -38,9 +39,9 @@ function registerCommand(program, commands) {
 registerCommand(program, commands);
 
 program.on('--help', () => {
-  log();
-  log(`  Run ${chalk.cyan(`${TMS_NAME}  <command> --help`)} for detailed usage of given command.`);
-  log();
+  info();
+  info(`  Run ${chalk.cyan(`${TMS_NAME}  <command> --help`)} for detailed usage of given command.`);
+  info();
 });
 
 // 捕获未注册的命令
@@ -48,8 +49,8 @@ program
   .arguments('<command>')
   .action((cmd) => {
     program.outputHelp();
-    log(`  ${chalk.red(`Unknown command ${chalk.yellow(cmd)}.`)}`);
-    log();
+    info(`  ${chalk.red(`Unknown command ${chalk.yellow(cmd)}.`)}`);
+    info();
     suggestCommands(cmd);
     process.exitCode = 1;
   });

package/src/init.js

@@ -1,7 +1,7 @@
 const semver = require('semver');
 const packageJson = require('../package.json');
 const chalk = require('chalk');
-const { log } = require('./utils/widgets');
+const { info } = require('./utils/log');
 
 const requiredVersion = packageJson.engines.node;
 const packName = packageJson.name;
@@ -14,7 +14,7 @@ const packName = packageJson.name;
  */
 const checkNodeVersion = (wanted, id) => {
   if (!semver.satisfies(process.version, wanted, { includePrerelease: true })) {
-    log(chalk.red(`你正在使用的Node版本： ${process.version}, 但是此版本的 ${id
+    info(chalk.red(`你正在使用的Node版本： ${process.version}, 但是此版本的 ${id
     } 需要的Node最小版本 ${wanted}.\n请先升级你的Node版本.`));
     process.exit(1);
   }

package/src/scripts/create/index.js

@@ -4,7 +4,7 @@ const shelljs = require('shelljs');
 const { TEMPLATE_DIR, TEMPLATE_PATH, TEMPLATE_TKIT_DIR } = require('../../config/constant.js');
 const { downloadRepoForGit, createTask, resolve } = require('../../utils/widgets');
 const io = require('../../utils/io');
-const { fail, succeed } = require('../../utils/log');
+const { fail, succeed, info } = require('../../utils/log');
 const generator = require('./generator');
 
 /**
@@ -65,7 +65,7 @@ async function create(appName) {
   })
     .catch((err) => {
       fail(err.message);
-      console.log('详细的错误信息:', err);
+      info('详细的错误信息:', err);
     });
 }
 

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

@@ -1,16 +1,15 @@
 const shelljs = require('shelljs');
 const { resolve } = require('../../../utils/widgets');
 const init = require('../init/index');
-const gulpBuild = require('../../../gulp/build');
+const compileBuild = require('../../../compile/build');
 
 async function build(tmsConfig, targetModules, env) {
   // 开始构建前，清理输出目录
   await shelljs.rm('-rf', resolve(tmsConfig.outputDir));
 
-  const isDev = false;
-  const { targetModules: newModules } = await init(tmsConfig, targetModules, isDev);
+  const { targetModules: newModules } = await init(tmsConfig, targetModules);
 
-  gulpBuild(tmsConfig, newModules, env);
+  compileBuild(tmsConfig, newModules, env);
 }
 
 module.exports = build;