@tmsfe/tmskit 0.0.7 → 0.0.9-beta.1

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

@@ -1,158 +1,234 @@
-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,
-};
+/**
+ * 用来读取处理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, isArray } = require('../utils/widgets');
+const defaultTmsConfig = require('../config/defaultTmsConfig');
+const { fail } = require('../utils/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) => {
+    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.config.js
+ */
+const readTmsPrivateCf = function () {
+  let tmsPrivateCf = {};
+  const tmsPrivatePath = resolve(TMS_PRIVATE_FILENAME);
+  if (fs.existsSync(tmsPrivatePath)) {
+    tmsPrivateCf = require(tmsPrivatePath);
+  }
+  // 处理modules字段
+  if (tmsPrivateCf.modules instanceof Array) {
+    Object.assign(tmsPrivateCf.modules, {
+      include: tmsPrivateCf.modules,
+    });
+  }
+  return tmsPrivateCf;
+};
+
+/**
+ * 从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;
+};
+
+/**
+ * 过滤页面为空的分包
+ * @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
+ * @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 findModule = false;
+        let moduleConfigContent = fs.readFileSync(moduleConfigPath, 'utf-8');
+        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({
+          ...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,
+  getModuleConfig,
+  getValidModules,
+  checkModules,
+  tmsModulesMergeLocalModuleCfg,
+  subModulesMergeDepModules,
+};

package/src/entry.js

@@ -1,60 +1,62 @@
-module.exports = [
-  {
-    command: 'create <app-name>',
-    description: '创建新的应用',
-    action: (appName, cmd) => {
-      require('./scripts/create')(appName, cmd);
-    },
-  },
-  {
-    name: 'run',
-    type: 'child',
-    description: '项目开发使用的命令',
-    commands: [
-      {
-        command: 'install',
-        description: '安装依赖',
-        options: [
-          ['-m, --module [moduleName]', '模块名称'],
-          ['-e, --env [env]', '环境变量'],
-        ],
-        action: (cmd) => {
-          require('./scripts/run/index')('install', cmd);
-        },
-      },
-      {
-        command: 'dev',
-        description: 'dev 打包编译',
-        options: [
-          ['-m, --module [moduleName]', '模块名称'],
-          ['-e, --env [env]', '环境变量'],
-        ],
-        action: (cmd) => {
-          require('./scripts/run/index')('dev', cmd);
-        },
-      },
-      {
-        command: 'build',
-        description: 'prod 打包编译',
-        options: [
-          ['-m, --module [moduleName]', '模块名称'],
-          ['-e, --env [env]', '环境变量'],
-        ],
-        action: (cmd) => {
-          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);
-        },
-      },
-    ],
-  },
-];
+module.exports = [
+  {
+    command: 'create <app-name>',
+    description: '创建新的应用',
+    action: (appName, cmd) => {
+      require('./scripts/create')(appName, cmd);
+    },
+  },
+  {
+    name: 'run',
+    type: 'child',
+    description: '项目开发使用的命令',
+    commands: [
+      {
+        command: 'install',
+        description: '安装依赖',
+        options: [
+          ['-m, --module [moduleName]', '模块名称'],
+          ['-e, --env [env]', '环境变量'],
+        ],
+        action: (cmd) => {
+          require('./scripts/run/index')('install', cmd);
+        },
+      },
+      {
+        command: 'dev',
+        description: 'dev 打包编译',
+        options: [
+          ['-m, --module [moduleName]', '模块名称'],
+          ['-e, --env [env]', '环境变量'],
+          ['-latest, --latest', '下载最新第三方模块代码、安装最新依赖'],
+        ],
+        action: (cmd) => {
+          require('./scripts/run/index')('dev', cmd);
+        },
+      },
+      {
+        command: 'build',
+        description: 'prod 打包编译',
+        options: [
+          ['-m, --module [moduleName]', '模块名称'],
+          ['-e, --env [env]', '环境变量'],
+        ],
+        action: (cmd) => {
+          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);
+      //   },
+      // },
+    ],
+  },
+];

package/src/index.js

@@ -1,62 +1,63 @@
-const chalk = require('chalk');
-const commander = require('commander');
-const { log, suggestCommands } = require('./utils/widgets');
-const { TMS_NAME } = require('./config/constant.js');
-const commands = require('./entry');
-const init = require('./init');
-
-init();
-
-const program = new commander.Command(TMS_NAME);
-
-program
-  .version(`${TMS_NAME} ${require('../package.json').version}`, '-v, -V, --version');
-
-function registerCommand(program, commands) {
-  commands.forEach((cmd) => {
-    if (cmd.type === 'child') {
-      const childProgram = new commander.Command(cmd.name);
-      cmd.usage && childProgram.usage(cmd.usage);
-      cmd.description && childProgram.description(cmd.description);
-      registerCommand(childProgram, cmd.commands);
-
-      program.addCommand(childProgram);
-    } else {
-      const command = program.command(cmd.command);
-
-      cmd.usage && command.usage(cmd.usage);
-
-      cmd.description && command.description(cmd.description);
-
-      cmd.options?.forEach(opt => command.option(...opt));
-
-      command.action(cmd.action);
-    }
-  });
-}
-
-registerCommand(program, commands);
-
-program.on('--help', () => {
-  log();
-  log(`  Run ${chalk.cyan(`${TMS_NAME}  <command> --help`)} for detailed usage of given command.`);
-  log();
-});
-
-// 捕获未注册的命令
-program
-  .arguments('<command>')
-  .action((cmd) => {
-    program.outputHelp();
-    log(`  ${chalk.red(`Unknown command ${chalk.yellow(cmd)}.`)}`);
-    log();
-    suggestCommands(cmd);
-    process.exitCode = 1;
-  });
-
-if (!process.argv.slice(2).length) {
-  program.outputHelp();
-  process.exit(-1);
-}
-
-program.parse(process.argv);
+const chalk = require('chalk');
+const commander = require('commander');
+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');
+
+init();
+
+const program = new commander.Command(TMS_NAME);
+
+program
+  .version(`${TMS_NAME} ${require('../package.json').version}`, '-v, -V, --version');
+
+function registerCommand(program, commands) {
+  commands.forEach((cmd) => {
+    if (cmd.type === 'child') {
+      const childProgram = new commander.Command(cmd.name);
+      cmd.usage && childProgram.usage(cmd.usage);
+      cmd.description && childProgram.description(cmd.description);
+      registerCommand(childProgram, cmd.commands);
+
+      program.addCommand(childProgram);
+    } else {
+      const command = program.command(cmd.command);
+
+      cmd.usage && command.usage(cmd.usage);
+
+      cmd.description && command.description(cmd.description);
+
+      cmd.options?.forEach(opt => command.option(...opt));
+
+      command.action(cmd.action);
+    }
+  });
+}
+
+registerCommand(program, commands);
+
+program.on('--help', () => {
+  info();
+  info(`  Run ${chalk.cyan(`${TMS_NAME}  <command> --help`)} for detailed usage of given command.`);
+  info();
+});
+
+// 捕获未注册的命令
+program
+  .arguments('<command>')
+  .action((cmd) => {
+    program.outputHelp();
+    info(`  ${chalk.red(`Unknown command ${chalk.yellow(cmd)}.`)}`);
+    info();
+    suggestCommands(cmd);
+    process.exitCode = 1;
+  });
+
+if (!process.argv.slice(2).length) {
+  program.outputHelp();
+  process.exit(-1);
+}
+
+program.parse(process.argv);