@tmsfe/tmskit 0.0.19 → 0.0.22

package/src/core/tmsMpconfig.js

@@ -1,64 +1,89 @@
 /**
  * 用来读取处理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');
 
 /**
  * 读取tms.config.js
- * @param env {string} 环境变量
+ *  @param {string} configPath tms.config.js的路径
  */
-const readTmsConfig = function (env) {
-  const tmsConfigPath = resolve(TMS_CONFIG_FILENAME);
+const readTmsConfig = function (configPath) {
+  const tmsConfigPath = configPath ? `${configPath}/${TMS_CONFIG_FILENAME}` : resolve(TMS_CONFIG_FILENAME);
   if (!fs.existsSync(tmsConfigPath)) {
-    fail('当前执行目录没有tms.config.js的配置项，请进行配置');
+    fail(`${path.dirname(tmsConfigPath)}没有找到tms.config.js，请进行配置`);
     process.exit(1);
   }
   const tmsConfigFn = require(tmsConfigPath);
-  const tmsConfig = tmsConfigFn({
-    env,
-  });
+  const tmsConfig = typeof tmsConfigFn === 'function' ? tmsConfigFn() : tmsConfigFn;
 
   // 合并默认值
-  return loadash.mergeWith(defaultTmsConfig, tmsConfig);
+  return loadash.mergeWith({}, defaultTmsConfig, tmsConfig);
 };
 
 
 /**
  * 读取tms.private.config.js
+ * @param {string} configPath tms.private.config.js的路径
  */
-const readTmsPrivateCf = function () {
+const readTmsPrivateCf = function (configPath) {
   let tmsPrivateCf = {};
-  const tmsPrivatePath = resolve(TMS_PRIVATE_FILENAME);
+  const tmsPrivatePath = configPath ? `${configPath}/${TMS_PRIVATE_FILENAME}` : 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的配置项
+ *  @param {string} configPath config.js的路径
+ * @returns
+ */
+const getTmsConfig = (configPath) => {
+  const tmsPrivateCf = readTmsPrivateCf(configPath);
+  const tmsConfig = readTmsConfig(configPath);
+
+  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;
 };
 
@@ -79,7 +104,7 @@ function adaptMpCgContent(fileContent, appName) {
     return res;
   };
 
-  let content = JSON.parse(fileContent);
+  let content = fileContent;
 
   if (isArray(content)) {
     let i = content.length - 1;
@@ -93,108 +118,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,14 +1,25 @@
 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);
+    },
+  },
+  {
+    command: 'install-cmd <npm-name>',
+    description: '安装扩展命令',
+    options: [
+      ['--registry [registry]', 'npm源'],
+    ],
+    action: (npmName, cmd) => {
+      const res = require('./scripts/extend-cmd');
+      res.installCmd(npmName, cmd);
     },
   },
   {
     name: 'run',
-    type: 'child',
+    type: 'parent',
     description: '项目开发使用的命令',
     commands: [
       {
@@ -56,18 +67,6 @@ 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);
-      //   },
-      // },
     ],
   },
 ];

package/src/index.js

@@ -1,57 +1,98 @@
+/* eslint-disable no-param-reassign */
 const chalk = require('chalk');
 const commander = require('commander');
-const { suggestCommands } = require('./utils/widgets');
-const { info } = require('./utils/log');
+const path = require('path');
+const fs = require('fs');
+const { resolve } = require('./utils/widgets');
+const { infoNoTime } = require('./utils/log');
+const { getTmsConfig } = require('../src/core/tmsMpconfig');
 const { TMS_NAME } = require('./config/constant.js');
 const commands = require('./entry');
-const init = require('./init');
-
-init();
+const check = require('./check');
+const { loadExtendCmd } = require('./scripts/extend-cmd/index.js');
+const report = require('./core/report');
 
+check();
 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') {
+    if (cmd.type === 'parent') {
       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.hook('preAction', (thisCommand) => {
+        report(`${thisCommand._name}-pre`);
+      });
+      // 上报
+      command.hook('postAction', (thisCommand) => {
+        report(`${thisCommand._name}-post`);
+      });
       command.action(cmd.action);
     }
   });
 }
 
-registerCommand(program, commands);
+// 注册扩展命令
+function registerExtendCommand(program, configPath) {
+  const tmsConfig = getTmsConfig(configPath);
+  if (tmsConfig?.commands) {
+    const commands = typeof tmsConfig.commands === 'function' ? tmsConfig.commands() : tmsConfig.commands;
+    if (Array.isArray(commands)) {
+      registerCommand(program, commands);
+    }
+  }
+}
+// 注册所有的命令
+function registerAllCmds(program, commands) {
+  // 注册脚手架内部命令
+  registerCommand(program, commands);
 
-program.on('--help', () => {
-  info(`  Run ${chalk.cyan(`${TMS_NAME}  <command> --help`)} for detailed usage of given command.`);
-});
+  // 注册npm包扩展命令
+  const cmdConfigs = loadExtendCmd();
+  cmdConfigs.forEach((cmdConfig) => {
+    registerExtendCommand(program, path.dirname(cmdConfig));
+  });
+
+  // 注册当前目录扩展命令
+  const tmsConfigPath = resolve('./tms.config.js');
+  if (fs.existsSync(tmsConfigPath)) {
+    registerExtendCommand(program, path.dirname(tmsConfigPath));
+  }
+}
+registerAllCmds(program, commands);
 
 // 捕获未注册的命令
 program
   .arguments('<command>')
+  .option('-c, --config <value>', '配置', (value) => {
+    // 注册指定配置的扩展命令
+    registerExtendCommand(program, path.dirname(resolve(value)));
+  })
   .action((cmd) => {
-    program.outputHelp();
-    info(` ${chalk.red(`Unknown command ${chalk.yellow(cmd)}.`)}`);
-    suggestCommands(cmd);
-    process.exitCode = 1;
+    infoNoTime(chalk.yellow(`
+      没有找到${cmd}命令
+      你可以通过${chalk.green('tmskit install-cmd <npm-name>')}安装扩展命令, ${chalk.green('扩展命令列表：https://www.npmjs.com/search?q=tmskit-cmd')}
+      你也可以通过 ${chalk.green('tmskit <command> --config=../tms.config.js')} 指定本地的扩展命令
+    `));
+    report(`${cmd}-not-find`);
   });
 
+program.on('--help', () => {
+  infoNoTime(`Run ${chalk.cyan(`${TMS_NAME}  <command> --help`)} for detailed usage of given command.`);
+});
+
 if (!process.argv.slice(2).length) {
   program.outputHelp();
   process.exit(-1);

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)