@tmsfe/tmskit 0.0.5-beta.5 → 0.0.7

package/src/utils/tkitUtils.js

@@ -1,84 +1,158 @@
-const loadash = require('lodash');
-const fs = require('fs');
-const { TMS_NAME, TMS_CONFIG_FILENAME, MODULE_CONFIG_FILENAME } = require('../config/constant');
-const { resolve, isObject } = require('./widgets');
-const { setModuleConfig } = require('./buildAppJson');
-const defaultTmsConfig = require('../config/defaultTmsConfig');
-const { fail } = require('./log');
-
-/**
- * 读取tms.config.json
- * @param env {string} 环境变量
- */
-const readTmsConfig = function (env) {
-  const tmsConfigPath = resolve(TMS_CONFIG_FILENAME);
-  if (!fs.existsSync(tmsConfigPath)) {
-    fail('当前执行目录没有tms.config.js的配置项，请进行配置');
-    process.exit(1);
-  }
-  const tmsConfigFn = require(tmsConfigPath);
-  const tmsConfig = tmsConfigFn({
-    env,
-  });
-  // 合并默认值
-  loadash.mergeWith(tmsConfig, defaultTmsConfig);
-  return tmsConfig;
-};
-
-/**
- * 从tms.config.json中检索用户传入的有效modules
- * @param { object } tmsConfig
- * @param { array } modules
- * @returns
- */
-const checkModules = function (tmsConfig, modules) {
-  const targetModules =  [];
-  modules.forEach((moduleName) => {
-    const module = tmsConfig.modules.find(module => module.name === moduleName);
-    module && targetModules.push(module);
-  });
-  if (targetModules.length === 0) {
-    fail(`你启动的模块无效，尝试 ${TMS_NAME} -m moduleName`);
-    process.exit(1);
-  }
-  return targetModules;
-};
-
-/**
- * tms.config.js的modules 合并 module.config.json的配置项
- * @param {array} modules
- * @param {string} appName
- * @param {string} moduleDir
- * @returns
- */
-const tmsModulesMergeLocalModuleCfg = (modules, appName, moduleDir) => {
-  const newModules = [];
-  modules.forEach(({ path: relativePath, name: moduleName }, moduleIndex) => {
-    const moduleConfigPath = resolve(relativePath, MODULE_CONFIG_FILENAME);
-    if (fs.existsSync(moduleConfigPath)) {
-      let moduleConfigContent = fs.readFileSync(moduleConfigPath, 'utf-8');
-      moduleConfigContent = setModuleConfig(moduleConfigContent, appName, moduleDir);
-      const moduleContentArr = isObject(moduleConfigContent) ? [moduleConfigContent] : moduleConfigContent;
-      moduleContentArr.forEach(({ name }, moduleContentArrIndex) => {
-        if (name === moduleName) {
-          newModules.push({
-            ...modules[moduleIndex],
-            ...moduleContentArr[moduleContentArrIndex],
-          });
-        }
-      });
-    } else {
-      newModules.push({
-        ...modules[moduleIndex],
-      });
-    }
-  });
-  return newModules;
-};
-
-
-module.exports = {
-  readTmsConfig,
-  checkModules,
-  tmsModulesMergeLocalModuleCfg,
-};
+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 defaultTmsConfig = require('../config/defaultTmsConfig');
+const { fail } = require('./log');
+const path = require('path');
+
+/**
+ * 读取tms.config.js
+ * @param env {string} 环境变量
+ */
+const readTmsConfig = function (env) {
+  const tmsConfigPath = resolve(TMS_CONFIG_FILENAME);
+  if (!fs.existsSync(tmsConfigPath)) {
+    fail('当前执行目录没有tms.config.js的配置项，请进行配置');
+    process.exit(1);
+  }
+  const tmsConfigFn = require(tmsConfigPath);
+  const tmsConfig = tmsConfigFn({
+    env,
+  });
+  // 合并默认值
+  loadash.mergeWith(tmsConfig, defaultTmsConfig);
+  // modules兼容处理
+  tmsConfig.modules = convertModules(tmsConfig.modules);
+  return tmsConfig;
+};
+
+// convertModules 处理默认值
+const convertModules = (modules) => {
+  const newModules = [];
+  modules.forEach((module, index) => {
+    const newModule = {};
+    if (typeof module === 'string') {
+      // 路径字符串
+      Object.assign(newModule, {
+        name: path.basename(module),
+        path: module,
+      });
+    } else if (typeof module === 'object') {
+      Object.assign(newModule, module);
+      if (module.name === undefined) {
+        newModule.name = path.basename(module.path);
+      }
+    }
+    newModules.push(newModule);
+  });
+  return newModules;
+};
+
+/**
+ * 读取tms.private.js
+ */
+const readTmsPrivateCf = function () {
+  let tmsPrivateCg;
+  const tmsPrivatePath = resolve(TMS_PRIVATE_FILENAME);
+  if (fs.existsSync(tmsPrivatePath)) {
+    tmsPrivateCg = require(tmsPrivatePath);
+  }
+  return tmsPrivateCg;
+};
+
+/**
+ * 从tms.config.json中检索用户传入的有效modules
+ * @param { object } tmsConfig
+ * @param { array } modules
+ * @returns
+ */
+const checkModules = function (tmsConfig, modules) {
+  const targetModules = [];
+  modules.forEach((moduleName) => {
+    const module = tmsConfig.modules.find(module => module.name === moduleName);
+    module && targetModules.push(module);
+  });
+  if (targetModules.length === 0) {
+    fail(`你启动的模块无效，尝试 ${TMS_NAME} -m moduleName`);
+    process.exit(1);
+  }
+  return targetModules;
+};
+
+/**
+ * tms.config.js的modules 合并 module.config.json的配置项
+ * @param {array} modules
+ * @param {string} appName
+ * @param {string} moduleDir
+ * @returns
+ */
+const tmsModulesMergeLocalModuleCfg = (modules, appName) => {
+  const newModules = [];
+  modules.forEach(({ path: relativePath, name: moduleName }, moduleIndex) => {
+    const moduleConfigPath = resolve(relativePath, MODULE_CONFIG_FILENAME);
+    if (fs.existsSync(moduleConfigPath)) {
+      try {
+        let moduleConfigContent = fs.readFileSync(moduleConfigPath, 'utf-8');
+        moduleConfigContent = setModuleConfig(moduleConfigContent, appName);
+        const moduleContentArr = isObject(moduleConfigContent) ? [moduleConfigContent] : moduleConfigContent;
+        getValidModules(moduleContentArr).forEach(({ name }, moduleContentArrIndex) => {
+          if (name === moduleName) {
+            newModules.push({
+              ...modules[moduleIndex],
+              ...moduleContentArr[moduleContentArrIndex],
+            });
+          }
+        });
+      } catch (e) {
+        fail(`${moduleConfigPath}配置错误: ${e}`);
+        newModules.push({
+          ...modules[moduleIndex],
+        });
+      }
+    } else {
+      newModules.push({
+        ...modules[moduleIndex],
+      });
+    }
+  });
+  return newModules;
+};
+
+/**
+ * 分包依赖了分包的模块 合并所依赖的modules
+ * @param { object } tmsConfig
+ * @param {array} modules
+ * @param {string} moduleDir
+ * @returns
+ */
+const subModulesMergeDepModules = (tmsConfig, modules) => {
+  const moduleNames = [];
+  modules.forEach(({ name: moduleName }) => {
+    moduleNames.push(moduleName);
+  });
+  let mergeModules = modules;
+  let isOver = true;
+  modules.forEach(({ dependencies: dependencyModules }) => {
+    dependencyModules?.forEach((item) => {
+      // 如果所有模块的dep都在moduleNames内，则所有依赖都齐了
+      // 否则递归处理，根据name找到相关配置加到modules里
+      if (moduleNames.indexOf(item) === -1) {
+        isOver = false;
+        const tmpModules = checkModules(tmsConfig, [...new Set([item])]);
+        mergeModules = [...mergeModules, ...tmpModules];
+        mergeModules = tmsModulesMergeLocalModuleCfg(mergeModules, tmsConfig.appName);
+      }
+    });
+  });
+  return isOver ? mergeModules : subModulesMergeDepModules(tmsConfig, mergeModules);
+};
+
+module.exports = {
+  readTmsConfig,
+  readTmsPrivateCf,
+  checkModules,
+  tmsModulesMergeLocalModuleCfg,
+  subModulesMergeDepModules,
+};

package/src/utils/widgets.js

@@ -1,173 +1,167 @@
-
-const program = require('commander');
-const leven = require('leven');
-const ora = require('ora');
-const path = require('path');
-const fs = require('fs');
-const shelljs = require('shelljs');
-const download = require('download-git-repo');
-const chalk = require('chalk');
-const shelljsOptions =  { slient: true };
-
-// 获取当前目录
-const cwd = process.cwd();
-function resolve(...args) {
-  return path.resolve(cwd, ...args);
-};
-
-/**
- * 封装logs
- * @returns {Undefined} 无需返回值
- */
-const log = (...args) => console.log(...args);
-
-/**
- * 用户输入命令时，进行提示
- * @param {String} unknownCommand 非预期的命令
- * @returns {Undefined} 无需返回值
- */
-const suggestCommands = (unknownCommand) => {
-  const availableCommands = program.commands.map(cmd => cmd._name);
-
-  let suggestion;
-  availableCommands.forEach((cmd) => {
-    const isBestMatch = leven(cmd, unknownCommand) < leven(suggestion || '', unknownCommand);
-    if (leven(cmd, unknownCommand) < 3 && isBestMatch) {
-      suggestion = cmd;
-    }
-  });
-
-  if (suggestion) {
-    log(`  ${chalk.red(`Did you mean ${chalk.yellow(suggestion)}?`)}`);
-  }
-};
-
-/**
- * 判断变量是否是一个数组
- * @param { unknown } obj 变量
- * @returns { boolean } 是否是一个数组
- */
-function isObject(obj) {
-  return Object.prototype.toString.call(obj) === '[object Object]';
-}
-
-/**
- * 判断变量是否是一个对象
- * @param { unknown } obj 变量
- * @returns { boolean } 是否是一个对象
- */
-function isArray(obj) {
-  return Object.prototype.toString.call(obj) === '[object Array]';
-}
-
-/**
- * 下载模块到目标目录
- * @param { string } dest 目标地址
- * @param { object } downloadOptions 模块下载配置 { repoUrl-仓库地址, gitUrl-git地址, branch-分支或者tag }
- * @returns { undefined } no return
- */
-function downloadRepo(dest, downloadOptions = { repoUrl: '', gitUrl: '', branch: '' }) {
-  const { repoUrl, gitUrl, branch } = downloadOptions;
-
-  if (fs.existsSync(dest)) {
-    shelljs.rm('-rf', dest);
-  }
-
-  shelljs.mkdir('-p', dest);
-  return new Promise((resolve) => {
-    download(`${repoUrl}#${branch}`, dest, { clone: true }, async (e) => {
-      if (e) {
-        console.log(e) // eslint-disable-line
-        await downloadRepoForGit(gitUrl, dest, branch);
-      }
-
-      resolve();
-    });
-  });
-}
-
-/**
- * 下载模块到目标目录备用方案
- * @param { string } url 模块地址
- * @param { string } dest 目标地址
- * @param { string } branch 分支名
- * @returns { undefined } no return
- */
-function downloadRepoForGit(url, dest, branch) {
-  const cwd = process.cwd();
-
-  return new Promise((resolve, reject) => {
-    // 如果目标目录不存在
-    if (fs.existsSync(dest)) {
-      shelljs.rm('-rf', path.join(dest));
-    }
-
-    shelljs.mkdir('-p', dest);
-    shelljs.cd(dest);
-
-    const gitCloneRes = shelljs.exec(`git clone ${url} ${dest} --branch ${branch} --depth 1`, shelljsOptions);
-    if (gitCloneRes.code !== 0) {
-      reject(gitCloneRes.stderr);
-    }
-
-    shelljs.cd(cwd);
-    resolve();
-  });
-}
-
-/**
- * 计算各项任务耗时
- * @param {Number} start 任务开始时间
- * @returns {Undefined} 无需返回值
- */
-const cost = start => Date.now() - start;
-
-/**
- * 创建构建子任务
- * @param {Function} task 子任务执行函数
- * @param {String} startText 任务开始前提示语
- * @param {String} endText 任务结束后提示语
- * @returns {Undefined} 无需返回值
- */
-function createTask(task, startText, endText) {
-  return async (...args) => {
-    const start = Date.now();
-    let result;
-
-    const spinner = ora(startText);
-    spinner.start();
-
-    try {
-      result = await task(...args);
-    } catch (e) {
-      result = e;
-      console.log(chalk.red(e));
-
-      process.exit(-1);
-    } finally {
-      endText && spinner.succeed(`${endText}, ${cost(start)}ms`);
-      spinner.stop();
-    }
-
-    return result;
-  };
-};
-
-/**
- * 字符串驼峰化处理
- * @param {String} str 需要处理的字符串
- * @returns {String} 经过驼峰处理的字符串
- */
-const camelize = str => str.replace(/-(\w)/g, (a, c) => (c ? c.toUpperCase() : ''));
-
-module.exports = {
-  resolve,
-  log,
-  isObject,
-  isArray,
-  createTask,
-  downloadRepo,
-  downloadRepoForGit,
-  suggestCommands,
-  camelize,
-};
+
+const program = require('commander');
+const leven = require('leven');
+const ora = require('ora');
+const path = require('path');
+const fs = require('fs');
+const shelljs = require('shelljs');
+const download = require('download-git-repo');
+const chalk = require('chalk');
+const shelljsOptions =  { slient: true };
+
+// 获取当前目录
+const cwd = process.cwd();
+function resolve(...args) {
+  return path.resolve(cwd, ...args);
+};
+
+/**
+ * 封装logs
+ * @returns {Undefined} 无需返回值
+ */
+const log = (...args) => console.log(...args);
+
+/**
+ * 用户输入命令时，进行提示
+ * @param {String} unknownCommand 非预期的命令
+ * @returns {Undefined} 无需返回值
+ */
+const suggestCommands = (unknownCommand) => {
+  const availableCommands = program.commands.map(cmd => cmd._name);
+
+  let suggestion;
+  availableCommands.forEach((cmd) => {
+    const isBestMatch = leven(cmd, unknownCommand) < leven(suggestion || '', unknownCommand);
+    if (leven(cmd, unknownCommand) < 3 && isBestMatch) {
+      suggestion = cmd;
+    }
+  });
+
+  if (suggestion) {
+    log(`  ${chalk.red(`Did you mean ${chalk.yellow(suggestion)}?`)}`);
+  }
+};
+
+/**
+ * 判断变量是否是一个数组
+ * @param { unknown } obj 变量
+ * @returns { boolean } 是否是一个数组
+ */
+function isObject(obj) {
+  return Object.prototype.toString.call(obj) === '[object Object]';
+}
+
+/**
+ * 判断变量是否是一个对象
+ * @param { unknown } obj 变量
+ * @returns { boolean } 是否是一个对象
+ */
+function isArray(obj) {
+  return Object.prototype.toString.call(obj) === '[object Array]';
+}
+
+/**
+ * 下载模块到目标目录
+ * @param { string } dest 目标地址
+ * @param { object } downloadOptions 模块下载配置 { repoUrl-仓库地址, gitUrl-git地址, branch-分支或者tag }
+ * @returns { undefined } no return
+ */
+function downloadRepo(dest, downloadOptions = { repoUrl: '', gitUrl: '', branch: '' }) {
+  const { repoUrl, gitUrl, branch } = downloadOptions;
+
+  if (fs.existsSync(dest)) {
+    shelljs.rm('-rf', dest);
+  }
+
+  shelljs.mkdir('-p', dest);
+  return new Promise((resolve) => {
+    download(`${repoUrl}#${branch}`, dest, { clone: true }, async (e) => {
+      if (e) {
+        console.log(e) // eslint-disable-line
+        await downloadRepoForGit(gitUrl, dest, branch);
+      }
+
+      resolve();
+    });
+  });
+}
+
+/**
+ * 下载模块到目标目录备用方案
+ * @param { string } url 模块地址
+ * @param { string } dest 目标地址
+ * @param { string } branch 分支名
+ * @returns { undefined } no return
+ */
+function downloadRepoForGit(url, dest, branch) {
+  const cwd = process.cwd();
+
+  return new Promise((resolve, reject) => {
+    // 如果目标目录不存在
+    if (fs.existsSync(dest)) {
+      shelljs.rm('-rf', path.join(dest));
+    }
+
+    shelljs.mkdir('-p', dest);
+    shelljs.cd(dest);
+
+    const gitCloneRes = shelljs.exec(`git clone ${url} ${dest} --branch ${branch} --depth 1`, shelljsOptions);
+    if (gitCloneRes.code !== 0) {
+      reject(gitCloneRes.stderr);
+    }
+
+    shelljs.cd(cwd);
+    resolve();
+  });
+}
+
+/**
+ * 计算各项任务耗时
+ * @param {Number} start 任务开始时间
+ * @returns {Undefined} 无需返回值
+ */
+const cost = start => Date.now() - start;
+
+/**
+ * 创建构建子任务
+ * @param {Function} task 子任务执行函数
+ * @param {String} startText 任务开始前提示语
+ * @param {String} endText 任务结束后提示语
+ * @returns {Undefined} 无需返回值
+ */
+function createTask(task, startText, endText) {
+  return async (...args) => {
+    const start = Date.now();
+
+    const spinner = ora(startText);
+
+    spinner.start();
+    console.log('\n');
+
+    const result = await task(...args);
+
+    endText && spinner.succeed(`${endText}, ${cost(start)}ms`);
+    spinner.stop();
+
+    return result;
+  };
+};
+
+/**
+ * 字符串驼峰化处理
+ * @param {String} str 需要处理的字符串
+ * @returns {String} 经过驼峰处理的字符串
+ */
+const camelize = str => str.replace(/-(\w)/g, (a, c) => (c ? c.toUpperCase() : ''));
+
+module.exports = {
+  resolve,
+  log,
+  isObject,
+  isArray,
+  createTask,
+  downloadRepo,
+  downloadRepoForGit,
+  suggestCommands,
+  camelize,
+};