@tmsfe/tmskit 0.0.18 → 0.0.21

package/src/core/symbolicLink.js

@@ -1,32 +1,30 @@
 const fs = require('fs');
 const { resolve } = require('../utils/widgets');
-const { handleError } = require('./handleError');
 const { ensureDirExist } = require('../utils/io');
-const { warn } = require('../utils/log');
+const { warn, succeed } = require('../utils/log');
 
 /**
  * 根据相关配置创建软链接
  * @param { object } tmsConfig
  */
 const symLink = (tmsConfig) => {
-  try {
-    ensureDirExist(resolve(tmsConfig.cloudDir));
-    if (tmsConfig.cloudModules) {
-      tmsConfig.cloudModules.forEach((item) => {
-        const sourcePath = resolve(item.path);
-        const targetPath = resolve(tmsConfig.cloudDir, item.name);
+  ensureDirExist(resolve(tmsConfig.cloudDir));
+  if (tmsConfig.cloudModules) {
+    tmsConfig.cloudModules.forEach((item) => {
+      const sourcePath = resolve(item.path);
+      const targetPath = resolve(tmsConfig.cloudDir, item.name);
 
-        if (!fs.existsSync(sourcePath)) {
-          warn(`云函数${sourcePath}不存在`);
-          return;
-        }
-        if (!fs.existsSync(targetPath)) {
-          fs.symlinkSync(sourcePath, targetPath);
-        }
-      });
-    }
-  } catch (e) {
-    handleError(`创建软链错误: ${e}`);
+      if (!fs.existsSync(sourcePath)) {
+        warn(`云函数${sourcePath}不存在`);
+        return;
+      }
+      if (!fs.existsSync(targetPath)) {
+        fs.symlinkSync(sourcePath, targetPath);
+      }
+    });
+    succeed('云函数创建软链成功');
+  } else {
+    warn('你没有在tms.config.js的cloudModules注册云函数');
   }
 };
 

package/src/core/tmsMpconfig.js

@@ -1,10 +1,12 @@
 /**
  * 用来读取处理tms.config.js与module.config.json字段
  */
+/* eslint-disable no-param-reassign, no-nested-ternary */
 const loadash = require('lodash');
 const fs = require('fs');
+const path = require('path');
 const { TMS_CONFIG_FILENAME, MODULE_CONFIG_FILENAME, TMS_PRIVATE_FILENAME } = require('../config/constant');
-const { resolve, isObject, isArray } = require('../utils/widgets');
+const { resolve, isObject, isArray, getAbsolutePath } = require('../utils/widgets');
 const defaultTmsConfig = require('../config/defaultTmsConfig');
 const { fail } = require('../utils/log');
 
@@ -12,20 +14,17 @@ const { fail } = require('../utils/log');
  * 读取tms.config.js
  * @param env {string} 环境变量
  */
-const readTmsConfig = function (env) {
+const readTmsConfig = function () {
   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);
+  const tmsConfig = typeof tmsConfigFn === 'function' ? tmsConfigFn() : tmsConfigFn;
 
-  return tmsConfig;
+  // 合并默认值
+  return loadash.mergeWith(defaultTmsConfig, tmsConfig);
 };
 
 
@@ -36,30 +35,53 @@ const readTmsPrivateCf = function () {
   let tmsPrivateCf = {};
   const tmsPrivatePath = resolve(TMS_PRIVATE_FILENAME);
   if (fs.existsSync(tmsPrivatePath)) {
-    tmsPrivateCf = require(tmsPrivatePath);
+    const tmsPrivateFn = require(tmsPrivatePath);
+    tmsPrivateCf = typeof tmsPrivateFn === 'function' ? tmsPrivateFn() : tmsPrivateFn;
   }
 
   return tmsPrivateCf;
 };
 
 /**
- * 从tms.config.json中检索用户传入的有效modules
+ * 获取tms.config.js， tms.private.config.js的配置项
+ * @returns
+ */
+const getTmsConfig = () => {
+  const tmsPrivateCf = readTmsPrivateCf();
+  const tmsConfig = readTmsConfig();
+
+  const modules = {};
+  if (Array.isArray(tmsConfig.modules)) {
+    modules.all = tmsConfig.modules;
+    tmsConfig.modules = modules;
+  }
+  // 合并默认值
+  const res = loadash.mergeWith(tmsConfig, tmsPrivateCf, (objValue, srcValue) => {
+    if (loadash.isArray(objValue) && objValue[0] && loadash.isObject(objValue[0])) {
+      return objValue.concat(srcValue);
+    }
+  });
+
+  return res;
+};
+
+/**
+ * 根据moduleNames获取modules
  * @param { object } tmsConfig
- * @param { array } modules
+ * @param { array } moduleNames
+ * @param {boolean} errorIsQuit 找不到配置文件是否退出
  * @returns
  */
-const checkModules = function (tmsConfig, modules, isQuit = false) {
+const getModulesByModuleNames = function (tmsConfig, moduleNames = []) {
   const targetModules = [];
-  modules.forEach((moduleName) => {
-    const module = tmsConfig.modules.all.find(module => module.name === moduleName);
-    module && targetModules.push(module);
+  moduleNames.forEach((moduleName) => {
+    const module = tmsConfig.modules.all.find(module => module.moduleName === moduleName);
+    if (!module) {
+      throw new Error(`你启动的模块${moduleName}在tms.config.js的modules.all中没有注册`);
+    }
+    targetModules.push(module);
   });
 
-  if (targetModules.length === 0) {
-    fail(`你启动的模块无效${modules.join(',')}无效，请检查tms.config.json>modules>${modules.join(',')}
-    >name字段与module.config.json的name字段是否一致`);
-    isQuit && process.exit(1);
-  }
   return targetModules;
 };
 
@@ -80,7 +102,7 @@ function adaptMpCgContent(fileContent, appName) {
     return res;
   };
 
-  let content = JSON.parse(fileContent);
+  let content = fileContent;
 
   if (isArray(content)) {
     let i = content.length - 1;
@@ -94,108 +116,175 @@ function adaptMpCgContent(fileContent, appName) {
   return content;
 }
 
+const adaptDependencies = function (dependencies, subPackages) {
+  const newDependencies = dependencies || [];
+  subPackages.forEach((item) => {
+    if (item.dependencies) {
+      dependencies = newDependencies.concat(item.dependencies);
+    }
+  });
+  return newDependencies;
+};
+
+const adaptSubPackages = function (moduleConfig, appName) {
+  const subPackages = isObject(moduleConfig) && moduleConfig.subPackages
+    ? moduleConfig.subPackages
+    : isObject(moduleConfig) ? [moduleConfig] : moduleConfig;
+  return adaptMpCgContent(subPackages, appName);
+};
+
 /**
- * 递归获取本地所有模块的配置信息
+ * 获取模块module.config.json中的配置信息
  * @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);
+function getModulesConfig(modules = [], appName) {
+  const modulesConfig = [];
+  modules.forEach((moduleItem) => {
+    const moduleConfigPath = resolve(moduleItem.path, MODULE_CONFIG_FILENAME);
+    let moduleConfig;
+    try {
+      moduleConfig = JSON.parse(fs.readFileSync(moduleConfigPath, 'utf-8'));
+    } catch (e) {
+      throw new Error(`${moduleConfigPath}json解析报错: ${e}`);
     }
+
+    // 兼容历史逻辑，后续可删除--- start
+    const subPackages = adaptSubPackages(moduleConfig, appName);
+    const dependencies = adaptDependencies(moduleConfig.dependencies, subPackages);
+    moduleConfig = {
+      ...(isObject(moduleConfig) ? moduleConfig : {}),
+      subPackages,
+      dependencies,
+    };
+    // 兼容逻辑--- end
+    modulesConfig.push(moduleConfig);
   });
 
   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((subPackage) => {
+      newSubPackages.push({
+        ...subPackage,
       });
-    }
+    });
   });
-  return newModules;
+  return newSubPackages;
+};
+
+/**
+ * 获取分包的root字段
+ * @param {*} modulePath 模块的编译路径
+ * @param {*} root 分包的root字段
+ * @returns
+ */
+const getSubPackageRoot = function (modulePath, root) {
+  return root.startsWith(modulePath) ? root : `${modulePath}/${root}`;
+};
+
+// 获取分包的源码路径
+const  getSubPackageSrcPath = function (tmsConfig, module, subPackage) {
+  const srcModulePath = getAbsolutePath(module.path);
+  const buildModulePath = resolve(tmsConfig.outputDir, module.modulePath);
+
+  const subPackageRoot = getSubPackageRoot(module.modulePath, subPackage.root);
+  const buildSubPackagePath = resolve(tmsConfig.outputDir, subPackageRoot);
+
+  const subPackageRelativeModule = path.relative(buildModulePath, buildSubPackagePath);
+  const srcSubPackagePath = path.join(srcModulePath, subPackageRelativeModule);
+
+  return srcSubPackagePath;
+};
+
+const checkModuleItem = (tmsConfig, tmsModuleItem, moduleConfig) => {
+  const newModuleItem = { ...tmsModuleItem, ...moduleConfig };
+
+  // 兼容逻辑
+  if (!newModuleItem.moduleName) newModuleItem.moduleName = newModuleItem.name;
+  delete newModuleItem.name;
+
+  // 参数校验-模块源码路径
+  if (!newModuleItem.path) {
+    throw new Error(`${newModuleItem.moduleName}模块没有找到path字段，请检查tms.config.js的modules.all>module>path路径`);
+  }
+
+  // 参数校验-模块编译路径
+  if (!newModuleItem.modulePath) {
+    throw new Error(`${newModuleItem.moduleName}模块的module.config.json中没有找到modulePath字段`);
+  }
+  // 参数校验-分包校验
+  for (const subPackage of newModuleItem.subPackages) {
+    if (!subPackage.root) {
+      throw new Error(`${newModuleItem.moduleName}模块的module.config.json中没有找到${subPackage.name}分包的root字段`);
+    }
+
+    // 参数校验-判断分包源码目录是否存在
+    const subPackageSrcPath = getSubPackageSrcPath(tmsConfig, newModuleItem, subPackage);
+    if (!subPackageSrcPath || !fs.existsSync(subPackageSrcPath)) {
+      throw new Error(`没有找到${newModuleItem.moduleName}模块的${subPackage.name}分包源码：${subPackageSrcPath}`);
+    }
+    subPackage.path = subPackageSrcPath;
+  }
+  return newModuleItem;
 };
 
 /**
- * 分包依赖了分包的模块 合并所依赖的modules
+ * 获取所有的模块，合并模块的依赖模块
  * @param { object } tmsConfig
  * @param {array} modules
- * @param {string} moduleDir
+ * @param {boolean} errorIsQuit 找不到配置文件是否退出
  * @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, errorIsQuit = false) => {
+  const allModules = new Map();
+  function dfs(tmsConfig, modules) {
+    modules.forEach((moduleItem) => {
+      const moduleConfigPath = resolve(moduleItem.path, MODULE_CONFIG_FILENAME);
+      if (!fs.existsSync(moduleConfigPath)) {
+        if (!allModules.has(moduleItem.moduleName)) {
+          allModules.set(moduleItem.moduleName, moduleItem);
+        }
+        if (errorIsQuit) {
+          throw new Error(`${moduleItem.moduleName}模块的配置文件module.config.json在${moduleItem.path}目录下没有找到`);
+        }
+        return;
+      }
+      const [moduleConfig = {}] = getModulesConfig([moduleItem], tmsConfig.appName);
+
+      if (!allModules.has(moduleItem.moduleName)) {
+        allModules.set(moduleItem.moduleName, checkModuleItem(tmsConfig, moduleItem, moduleConfig));
+
+        const dependenciesModules = getModulesByModuleNames(tmsConfig, moduleConfig?.dependencies);
+        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,
-  checkModules,
-  tmsModulesMergeLocalModuleCfg,
-  subModulesMergeDepModules,
+  getModulesConfig,
+  getModulesByModuleNames,
+  getSubPackages,
+  getModulesByMergeDepModules,
+  getTmsConfig,
 };

package/src/entry.js

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

package/src/index.js

@@ -1,12 +1,14 @@
 const chalk = require('chalk');
 const commander = require('commander');
-const { suggestCommands } = require('./utils/widgets');
+const { suggestCommands, resolve } = require('./utils/widgets');
 const { info } = require('./utils/log');
+const { getTmsConfig } = require('../src/core/tmsMpconfig');
 const { TMS_NAME } = require('./config/constant.js');
 const commands = require('./entry');
-const init = require('./init');
+const check = require('./check');
+const fs = require('fs');
 
-init();
+check();
 
 const program = new commander.Command(TMS_NAME);
 
@@ -36,7 +38,19 @@ function registerCommand(program, commands) {
   });
 }
 
-registerCommand(program, commands);
+function register() {
+  // 注册脚手架内部命令
+  registerCommand(program, commands);
+
+  // 注册扩展命令
+  if (fs.existsSync(resolve('tms.config.js'))) {
+    const tmsConfig = getTmsConfig();
+    if (Array.isArray(tmsConfig?.commands)) {
+      registerCommand(program, tmsConfig.commands);
+    }
+  }
+}
+register();
 
 program.on('--help', () => {
   info(`  Run ${chalk.cyan(`${TMS_NAME}  <command> --help`)} for detailed usage of given command.`);

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 } = 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, isDev);
 }
 
 module.exports = build;

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

@@ -1,11 +1,9 @@
 const { symLink } = require('../../../core/symbolicLink');
 const { handleError } = require('../../../core/handleError');
-const { succeed } = require('../../../utils/log');
 
 module.exports = async (tmsConfig) => {
   try {
     await symLink(tmsConfig);
-    succeed('云函数创建软链成功');
   } catch (e) {
     handleError(`创建软链错误: ${e}`);
   }