@tmsfe/tmskit 0.0.19 → 0.0.20

package/src/core/tmsMpconfig.js

@@ -1,6 +1,7 @@
 /**
  * 用来读取处理tms.config.js与module.config.json字段
  */
+/* eslint-disable no-param-reassign, no-nested-ternary */
 const loadash = require('lodash');
 const fs = require('fs');
 const { TMS_CONFIG_FILENAME, MODULE_CONFIG_FILENAME, TMS_PRIVATE_FILENAME } = require('../config/constant');
@@ -50,7 +51,7 @@ const readTmsPrivateCf = function () {
 const checkModules = function (tmsConfig, modules, isQuit = false) {
   const targetModules = [];
   modules.forEach((moduleName) => {
-    const module = tmsConfig.modules.all.find(module => module.name === moduleName);
+    const module = tmsConfig.modules.all.find(module => module.moduleName === moduleName);
     module && targetModules.push(module);
   });
 
@@ -79,7 +80,7 @@ function adaptMpCgContent(fileContent, appName) {
     return res;
   };
 
-  let content = JSON.parse(fileContent);
+  let content = fileContent;
 
   if (isArray(content)) {
     let i = content.length - 1;
@@ -94,107 +95,119 @@ function adaptMpCgContent(fileContent, appName) {
 }
 
 /**
- * 递归获取本地所有模块的配置信息
+ * 获取模块module.config.json中的配置信息
  * @param {array} modules 用户要编译的模块列表
  * @param { string } appName 小程序的名称
- * @param { string } moduleConfigFilename moduleConfig的文件名
+ * @param {boolean} notFindIsQuit 找不到配置文件是否退出
  */
-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);
+function getModulesConfig(modules = [], appName, notFindIsQuit) {
+  const modulesConfig = [];
+  modules.forEach((moduleItem) => {
+    if (!moduleItem.path) {
+      throw new Error(`${moduleItem.moduleName}模块路径配置没有找到`);
     }
+    const moduleConfigPath = resolve(moduleItem.path, MODULE_CONFIG_FILENAME);
+    if (!fs.existsSync(moduleConfigPath)) {
+      if (notFindIsQuit) {
+        throw new Error(`${moduleItem.moduleName}模块的配置文件module.config.json在${moduleItem.path}目录下没有找到`);
+      }
+      return;
+    }
+    let moduleConfig;
+    try {
+      moduleConfig = JSON.parse(fs.readFileSync(moduleConfigPath, 'utf-8'));
+    } catch (e) {
+      throw new Error(`${moduleConfigPath}json解析报错: ${e}`);
+    }
+
+    // 兼容历史逻辑，后续可删除--- start
+    if (!moduleItem.moduleName) moduleItem.moduleName = moduleItem.name;
+    delete moduleItem.name;
+
+    let subPackages = isObject(moduleConfig) && moduleConfig.subPackages
+      ? moduleConfig.subPackages
+      : isObject(moduleConfig) ? [moduleConfig] : moduleConfig;
+
+    subPackages = adaptMpCgContent(subPackages, appName);
+    let dependencies = moduleConfig.dependencies || [];
+    subPackages.forEach((item) => {
+      item.path = moduleItem.path;
+      if (item.dependencies) {
+        dependencies = dependencies.concat(item.dependencies);
+      }
+    });
+    moduleItem.subPackages = subPackages;
+    moduleItem.dependencies = dependencies;
+    // 兼容逻辑--- end
+
+    modulesConfig.push(moduleItem);
   });
 
   return modulesConfig;
 }
 
 /**
- * tms.config.js的modules 合并 module.config.json的配置项
+ * 获取分包内容 （读取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;
-        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],
+const getSubPackages = (modules) => {
+  const newSubPackages = [];
+  modules.forEach((module) => {
+    (module.subPackages || []).forEach((item) => {
+      newSubPackages.push({
+        path: module.path,
+        ...item,
       });
-    }
+    });
   });
-  return newModules;
+  return newSubPackages;
 };
 
 /**
- * 分包依赖了分包的模块 合并所依赖的modules
+ * 获取所有的模块，合并模块的依赖模块
  * @param { object } tmsConfig
  * @param {array} modules
- * @param {string} moduleDir
+ * @param {boolean} notFindIsQuit 找不到配置文件是否退出
  * @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) {
-        const tmpModules = checkModules(tmsConfig, [...new Set([item])]);
-        if (tmpModules.length > 0) {
-          isOver = false;
-          mergeModules = [...mergeModules, ...tmpModules];
-          mergeModules = tmsModulesMergeLocalModuleCfg(mergeModules, tmsConfig.appName);
+const getModulesByMergeDepModules = (tmsConfig, modules, notFindIsQuit = false) => {
+  const allModules = new Map();
+  function dfs(tmsConfig, modules) {
+    modules.forEach((moduleItem) => {
+      const [moduleConfig = {}] = getModulesConfig([moduleItem], tmsConfig.appName, notFindIsQuit);
+
+      if (!allModules.has(moduleItem.moduleName)) {
+        allModules.set(moduleItem.moduleName, { ...moduleItem, ...moduleConfig });
+
+        const dependenciesModules = [];
+        (moduleConfig?.dependencies || []).forEach((dependenciesModule) => {
+          tmsConfig.modules.all.forEach((module) => {
+            if (dependenciesModule === module.moduleName) {
+              dependenciesModules.push({ ...module });
+            }
+          });
+        });
+        if (dependenciesModules.length) {
+          dfs(tmsConfig, dependenciesModules);
         }
       }
     });
-  });
-  return isOver ? mergeModules : subModulesMergeDepModules(tmsConfig, mergeModules);
+  }
+  dfs(tmsConfig, modules);
+
+  const modulesArr = [];
+  for (const module of allModules.values()) {
+    modulesArr.push(module);
+  }
+  return modulesArr;
 };
 
 module.exports = {
   readTmsConfig,
   readTmsPrivateCf,
-  getModuleConfig,
+  getModulesConfig,
   checkModules,
-  tmsModulesMergeLocalModuleCfg,
-  subModulesMergeDepModules,
+  getSubPackages,
+  getModulesByMergeDepModules,
 };

package/src/entry.js

@@ -1,9 +1,9 @@
 module.exports = [
   {
-    command: 'create <app-name>',
+    command: 'create <project-name>',
     description: '创建新的应用',
-    action: (appName, cmd) => {
-      require('./scripts/create')(appName, cmd);
+    action: (projectName) => {
+      require('./scripts/create')(projectName);
     },
   },
   {

package/src/scripts/create/generator.js

@@ -3,8 +3,7 @@ const render = require('./render');
 const ask = require('./ask');
 const FILES_TO_IGNORE = require('./ignoreFiles');
 
-
-const generator = (buildDir, distDir, preMetadata) => new Promise((resolve, reject) => {
+const generator = (buildDir, distDir, preMetadata = {}) => new Promise((resolve, reject) => {
   Metalsmith(buildDir)
     .metadata(preMetadata)
     .ignore(FILES_TO_IGNORE)

package/src/scripts/create/index.js

@@ -1,18 +1,27 @@
 const path = require('path');
 const fs = require('fs');
 const shelljs = require('shelljs');
-const { TEMPLATE_DIR, TEMPLATE_PATH, TEMPLATE_TKIT_DIR } = require('../../config/constant.js');
-const { downloadRepoForGit, createTask, resolve } = require('../../utils/widgets');
+const inquirer = require('inquirer');
+const {
+  TEMPLATE_DIR,
+  TEMPLATE_URL,
+  TEMPLATE_NAME,
+  TEMPLATE_TKIT_DIR,
+  CREATE_TEMPLATE_QUESTION,
+} = require('../../config/constant.js');
+const { resolve } = require('../../utils/widgets');
 const io = require('../../utils/io');
 const { fail, succeed, info } = require('../../utils/log');
 const generator = require('./generator');
+const request = require('request');
+const unzip = require('unzipper');
 
 /**
  * 如果该目录下面存在文件，换个名字
  * @param { string } targetDir 当前文件夹
  * @returns { undefined }
  */
-async function createAppDir(targetDir) {
+async function createProjectDir(targetDir) {
   // 如果目录非空或者已经存在，提示用户，做选择
   if (fs.existsSync(targetDir)) {
     if (!await io.isDirEmpty(targetDir)) {
@@ -24,43 +33,75 @@ async function createAppDir(targetDir) {
   }
 }
 
+/**
+ * 下载和解压远程的小程序模板
+ * @param {string} templateDir
+ * @param {string} templateUrl
+ * @param {string} templateName
+ * @returns
+ */
+function downloadAndUnZipTemplate(templateDir, templateUrl, templateName) {
+  return new Promise((resolve, reject) => {
+    const localZipPath = `${templateDir}/${templateName}.zip`;
+    const stream = fs.createWriteStream(localZipPath);
+    request(`${templateUrl}?v=${new Date().getTime()}`).pipe(stream)
+      .on('close', (err) => {
+        if (err) {
+          reject(err);
+          return;
+        }
+        fs.createReadStream(localZipPath).pipe(unzip.Extract({ path: templateDir }))
+          .on('close', (err) => {
+            if (err) {
+              reject(err);
+              return;
+            }
+            resolve();
+          });
+      });
+  });
+}
+
 /**
  * 创建本地小程序运行环境
- * @param { string } appType 项目类型
- * @param { string } appName 项目名称
+ * @param { string } projectType 项目类型
+ * @param { string } projectName 项目名称
  */
-async function create(appName) {
+async function create(projectName) {
   const cwd = process.cwd();
-  const targetDir = path.resolve(cwd, appName);
-  const appType = 'mp';
-  await createAppDir(targetDir);
+  const targetDir = path.resolve(cwd, projectName);
+  const { projectType } = await inquirer.prompt(CREATE_TEMPLATE_QUESTION);
 
-  // 创建缓存目录
-  io.ensureDirExist(TEMPLATE_DIR);
-  // 拉取git模板
-  await createTask(downloadRepoForGit, '拉取模板仓库', '拉取模板仓库完成')(
-    'https://git.woa.com/tmsfe/tms-frontend.git',
-    TEMPLATE_DIR,
-    'master',
-  );
+  // 创建项目目录
+  await createProjectDir(targetDir);
+
+  // 新创建缓存目录
+  if (fs.existsSync(TEMPLATE_DIR)) {
+    shelljs.rm('-rf', TEMPLATE_DIR);
+  }
+  fs.mkdirSync(TEMPLATE_DIR, { recursive: true });
+
+  // 下载和解压模板
+  await downloadAndUnZipTemplate(TEMPLATE_DIR, TEMPLATE_URL, TEMPLATE_NAME);
 
   // 生成模板(1. 询问问题， 2. ejs生成模板  3.生成到目标目录)
-  generator(path.join(TEMPLATE_PATH, appType), targetDir, {
-    appName,
-    appType,
-  }).then(() => {
-    shelljs.cd(appName);
-    const hooks = require(resolve(appName, TEMPLATE_TKIT_DIR, 'hooks.js'));
-    if (hooks.afterCreate) {
-      hooks.afterCreate.forEach((item) => {
-        if (typeof item === 'function') {
-          item.call(null, shelljs, { appName });
-        } else {
-          shelljs.exec(item);
-        }
-      });
+  generator(path.join(TEMPLATE_DIR, TEMPLATE_NAME, projectType), targetDir).then(() => {
+    shelljs.cd(projectName);
+    const hookFilePath = resolve(projectName, TEMPLATE_TKIT_DIR, 'hooks.js');
+    if (fs.existsSync(hookFilePath)) {
+      const hooks = require(hookFilePath);
+      if (hooks.afterCreate) {
+        hooks.afterCreate.forEach((item) => {
+          if (typeof item === 'function') {
+            item.call(null, shelljs, { projectName });
+          } else {
+            shelljs.exec(item);
+          }
+        });
+      }
+      shelljs.rm('-rf', resolve(projectName, TEMPLATE_TKIT_DIR));
     }
-    shelljs.rm('-rf', resolve(appName, TEMPLATE_TKIT_DIR));
+
     succeed('项目创建完成.');
   })
     .catch((err) => {

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

@@ -3,19 +3,20 @@ const { resolve, filterField } = require('../../../utils/widgets');
 const init = require('../init/index');
 const compileBuild = require('../../../compile/build');
 
-async function build(tmsConfig, targetModules, env) {
+async function build(tmsConfig, targetModules) {
   // 开始构建前，清理输出目录
   await shelljs.rm('-rf', resolve(tmsConfig.outputDir));
 
-  const { targetModules: newModules } = await init(tmsConfig, targetModules);
+  const { modules: newModules, subPackages } = await init(tmsConfig, targetModules);
 
+  const isDev = false;
   if (typeof tmsConfig?.hooks?.beforeCompile === 'function') {
     await tmsConfig?.hooks?.beforeCompile({
-      isDev: false,
+      isDev,
       tmsConfig: filterField(tmsConfig, ['gitAccount']),
       modules: newModules });
   };
-  compileBuild(tmsConfig, newModules, env);
+  compileBuild(tmsConfig, newModules, subPackages, isDev);
 }
 
 module.exports = build;

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

@@ -2,18 +2,21 @@ const shelljs = require('shelljs');
 const compileDev = require('../../../compile/dev');
 const { resolve, filterField } = require('../../../utils/widgets');
 const init = require('../init/index');
-const { tmsModulesMergeLocalModuleCfg } = require('../../../core/tmsMpconfig');
+const { getModulesByMergeDepModules, getSubPackages } = require('../../../core/tmsMpconfig');
 const { info } = require('../../../utils/log');
 const { global } = require('../../../utils/global');
 const { CACHE_DIR } = require('../../../config/constant');
 
 
 // 用户编译分包时，需要将dist中其他分包(主包不能删除)的内容删除，否则其他分包的内容混入到主包(导致主包的体积超2M)
-function delOtherModule(tmsConfig, targetModules) {
-  const modules = tmsModulesMergeLocalModuleCfg(tmsConfig.modules.all, tmsConfig.appName);
-  const targetModulesName = targetModules.map(item => item.name);
-  modules.forEach((item) => {
-    if (item.root && targetModulesName.indexOf(item.name) === -1) {
+function delOtherPackages(tmsConfig, targetSubPackages) {
+  // 获取所有模块，合并模块依赖的模块
+  const allModules = getModulesByMergeDepModules(tmsConfig, tmsConfig.modules.all);
+  // 获取所有的分包
+  const allSubPackages = getSubPackages(allModules);
+  const targetSubPackagesName = targetSubPackages.map(item => item.name);
+  allSubPackages.forEach((item) => {
+    if (item.root && targetSubPackagesName.indexOf(item.name) === -1) {
       const moduleRootDir = resolve(`${tmsConfig.outputDir}/${item.root}`);
       shelljs.rm('-rf', `${moduleRootDir}/*`, { silent: true });
       // 解决微信开发者工具（dist/app.json: ["subpackages"][0]["root"] 字段需为 目录）错误 - 提前创建该目录
@@ -22,8 +25,7 @@ function delOtherModule(tmsConfig, targetModules) {
   });
 }
 
-async function dev(tmsConfig, targetModules, env) {
-  let newModules = targetModules;
+async function dev(tmsConfig, targetModules) {
   const { noCache } = global.getData('cmd');
   if (noCache) {
     shelljs.rm('-rf', resolve(tmsConfig.outputDir));
@@ -31,10 +33,9 @@ async function dev(tmsConfig, targetModules, env) {
   }
 
   // 初始化操作
-  const initData = await init(tmsConfig, newModules);
-  newModules = initData.targetModules;
+  const { subPackages, modules: newModules } = await init(tmsConfig, targetModules);
 
-  info('当前dev启动的有效模块', newModules.map(item => item.name).sort());
+  info('当前dev启动的有效模块', newModules.map(item => item.moduleName).sort());
   if (typeof tmsConfig?.hooks?.beforeCompile === 'function') {
     await tmsConfig?.hooks?.beforeCompile({
       isDev: true,
@@ -42,8 +43,8 @@ async function dev(tmsConfig, targetModules, env) {
       modules: newModules,
     });
   };
-  delOtherModule(tmsConfig, newModules);
-  compileDev(tmsConfig, newModules, env);
+  delOtherPackages(tmsConfig, subPackages);
+  compileDev(tmsConfig, newModules, subPackages, true);
 }
 
 module.exports = dev;

package/src/scripts/run/index.js

@@ -5,13 +5,14 @@ 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) => {
@@ -37,14 +38,20 @@ const getSpecificModules = (moduleArg, modules) => {
     return include;
   }
   if (exclude?.length > 0) {
-    return all.filter(module => !exclude.includes(module.name)).map(item => item.name);
+    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.name);
+    return all.filter(module => module.repoInfo === undefined).map(item => item.moduleName);
   }
-  return all.map(item => item.name);
+  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)) {
@@ -62,61 +69,68 @@ const mergeConfig = (tmsConfig, tmsPrivateCf) => {
 };
 
 async function run(commandName, cmd) {
+  try {
   // 用户本地的私有项目配置
-  const tmsPrivateCf = readTmsPrivateCf();
-  const { env = tmsPrivateCf?.env } = cmd;
-  let tmsConfig = readTmsConfig(env);
-  tmsConfig = mergeConfig(tmsConfig, tmsPrivateCf);
+    const tmsPrivateCf = readTmsPrivateCf();
+    const { env = tmsPrivateCf?.env } = cmd;
+    let tmsConfig = readTmsConfig(env);
+    tmsConfig = mergeConfig(tmsConfig, tmsPrivateCf);
 
-  // 处理module参数
-  const specificModules = getSpecificModules(
-    handleModuleArg(cmd),
-    tmsConfig.modules,
-  );
+    // 处理module参数
+    const specificModules = getSpecificModules(
+      handleModuleArg(cmd),
+      tmsConfig.modules,
+    );
 
-  const modules = checkModules(
-    tmsConfig,
-    [
-      ...new Set([
-        ...tmsConfig.mainPackages,
-        ...specificModules,
-      ]),
-    ],
-    true,
-  );
+    const modules = checkModules(
+      tmsConfig,
+      [
+        ...new Set([
+          ...tmsConfig.mainPackages,
+          ...specificModules,
+        ]),
+      ],
+      true,
+    );
 
-  // tms.config.js的modules 合并 module.config.json的配置项
-  let newModules = tmsModulesMergeLocalModuleCfg(modules, tmsConfig.appName);
-  // A分包依赖了B分包的代码， merge B分包进行编译；
-  newModules = subModulesMergeDepModules(tmsConfig, newModules);
+    // 获取所有模块，合并模块依赖的模块
+    const newModules = getModulesByMergeDepModules(tmsConfig, modules);
+    // 获取所有的分包
+    const subPackages = getSubPackages(newModules);
 
-  // 缓存数据
-  global.setData({
-    env,
-    cmd,
-    tmsConfig,
-  });
+    // 缓存数据
+    global.setData({
+      env,
+      cmd,
+      tmsConfig,
+    });
 
-  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, false);
-      return;
-    case 'build':
-      global.setData('isDev', false);
-      build(tmsConfig, newModules, env);
-      return;
-    default:
-      return;
+    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);
   }
 }