@tmsfe/tmskit 0.0.5 → 0.0.8

package/src/core/tmsMpconfig.js

@@ -0,0 +1,234 @@
+/**
+ * 用来读取处理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

@@ -7,14 +7,56 @@ module.exports = [
     },
   },
   {
-    command: 'run <command-name>',
-    options: [
-      ['-m, --module [moduleName]', '模块名称'],
-      ['-e, --env [env]', '环境变量'],
+    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);
+      //   },
+      // },
     ],
-    description: '运行模块',
-    action: (commandName, cmd) => {
-      require('./scripts/run/index')(commandName, cmd);
-    },
   },
 ];

package/src/index.js

@@ -1,31 +1,47 @@
 const chalk = require('chalk');
-const program = require('commander');
-const { log, suggestCommands } = require('./utils/widgets');
+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}`);
+  .version(`${TMS_NAME} ${require('../package.json').version}`, '-v, -V, --version');
 
-commands.forEach((cmd) => {
-  const command = program.command(cmd.command);
+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);
 
-  cmd.usage && command.usage(cmd.usage);
+      program.addCommand(childProgram);
+    } else {
+      const command = program.command(cmd.command);
 
-  cmd.description && command.description(cmd.description);
+      cmd.usage && command.usage(cmd.usage);
 
-  cmd.options?.forEach(opt => command.option(...opt));
+      cmd.description && command.description(cmd.description);
 
-  command.action(cmd.action);
-});
+      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();
+  info();
+  info(`  Run ${chalk.cyan(`${TMS_NAME}  <command> --help`)} for detailed usage of given command.`);
+  info();
 });
 
 // 捕获未注册的命令
@@ -33,8 +49,8 @@ program
   .arguments('<command>')
   .action((cmd) => {
     program.outputHelp();
-    log(`  ${chalk.red(`Unknown command ${chalk.yellow(cmd)}.`)}`);
-    log();
+    info(`  ${chalk.red(`Unknown command ${chalk.yellow(cmd)}.`)}`);
+    info();
     suggestCommands(cmd);
     process.exitCode = 1;
   });

package/src/init.js

@@ -1,8 +1,7 @@
-const { exec } = require('shelljs');
 const semver = require('semver');
 const packageJson = require('../package.json');
 const chalk = require('chalk');
-const { log } = require('./utils/widgets');
+const { info } = require('./utils/log');
 
 const requiredVersion = packageJson.engines.node;
 const packName = packageJson.name;
@@ -15,7 +14,7 @@ const packName = packageJson.name;
  */
 const checkNodeVersion = (wanted, id) => {
   if (!semver.satisfies(process.version, wanted, { includePrerelease: true })) {
-    log(chalk.red(`你正在使用的Node版本： ${process.version}, 但是此版本的 ${id
+    info(chalk.red(`你正在使用的Node版本： ${process.version}, 但是此版本的 ${id
     } 需要的Node最小版本 ${wanted}.\n请先升级你的Node版本.`));
     process.exit(1);
   }
@@ -29,10 +28,6 @@ function initCliContext() {
   // 执行操作前检查node版本
   // 旧版本node直接提示升级，退出脚本
   checkNodeVersion(requiredVersion, packName);
-
-
-  // 执行前配置正确的npm源
-  exec('npm config set registry https://mirrors.tencent.com/npm/ --global', { silent: true });
 }
 
 module.exports = initCliContext;

package/src/scripts/create/index.js

@@ -4,7 +4,7 @@ const shelljs = require('shelljs');
 const { TEMPLATE_DIR, TEMPLATE_PATH, TEMPLATE_TKIT_DIR } = require('../../config/constant.js');
 const { downloadRepoForGit, createTask, resolve } = require('../../utils/widgets');
 const io = require('../../utils/io');
-const { fail, succeed } = require('../../utils/log');
+const { fail, succeed, info } = require('../../utils/log');
 const generator = require('./generator');
 
 /**
@@ -65,7 +65,7 @@ async function create(appName) {
   })
     .catch((err) => {
       fail(err.message);
-      console.log('详细的错误信息:', err);
+      info('详细的错误信息:', err);
     });
 }
 

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

@@ -1,15 +1,15 @@
 const shelljs = require('shelljs');
-const webpackBuildServer = require('../../../webpack/buildServer');
 const { resolve } = require('../../../utils/widgets');
 const init = require('../init/index');
+const compileBuild = require('../../../compile/build');
 
 async function build(tmsConfig, targetModules, env) {
   // 开始构建前，清理输出目录
-  await shelljs.rm('-rf', resolve('dist'));
+  await shelljs.rm('-rf', resolve(tmsConfig.outputDir));
 
   const { targetModules: newModules } = await init(tmsConfig, targetModules);
 
-  webpackBuildServer(tmsConfig, newModules, env);
+  compileBuild(tmsConfig, newModules, env);
 }
 
 module.exports = build;

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

@@ -1,66 +1,41 @@
-const webpackServer = require('../../../webpack/devServer');
-const fs = require('fs');
+const shelljs = require('shelljs');
+const compileDev = require('../../../compile/dev');
 const { resolve } = require('../../../utils/widgets');
 const init = require('../init/index');
-const { DEFAULT_MODULE_DIR } = require('../../../config/constant');
-const { tmsModulesMergeLocalModuleCfg } = require('../../../utils/tkitUtils');
-const { checkDependencies } = require('../../../utils/checkDependencies');
-const { fail } = require('../../../utils/log');
-
-function isInit(tmsConfig, targetModules, contextDir) {
-  // 判断是否存在dist目录
-  if (!fs.existsSync(contextDir)) {
-    return true;
-  }
-  // 判断dist是否存在node_modules
-  if (!fs.existsSync(`${contextDir}/node_modules`)) {
-    return true;
-  }
-
-  // 判断dist是否存在miniprogram_npm
-  if (!fs.existsSync(`${contextDir}/miniprogram_npm`)) {
-    return true;
-  }
-
-  // 判断dist是否存在app.json
-  if (!fs.existsSync(`${contextDir}/app.json`)) {
-    return true;
-  }
-
-  // 判断\源码\dist\是否存在用户指定的模块
-  for (const item of targetModules) {
-    // 此模块没有root字段(原因：没有merge到module.config.json的配置项。第三方模块的代码可能还没有下载)
-    if (!item.root) {
-      return true;
-    }
-    // 判断编译目录是否有该模块
-    if (!fs.existsSync(`${contextDir}/${item.root}`)) {
-      return true;
+const { isInit } = require('../../../core/isInIt');
+const { tmsModulesMergeLocalModuleCfg } = require('../../../core/tmsMpconfig');
+const { info } = require('../../../utils/log');
+const { global } = require('../../../utils/global');
+
+
+// 用户编译分包时，需要将dist中其他分包(主包不能删除)的内容删除，否则其他分包的内容混入到主包(导致主包的体积超2M)
+function delOtherModule(tmsConfig, targetModules) {
+  const modules = tmsModulesMergeLocalModuleCfg(tmsConfig.modules, tmsConfig.appName);
+  const targetModulesName = targetModules.map(item => item.name);
+  modules.forEach((item) => {
+    if (item.root && targetModulesName.indexOf(item.name) === -1) {
+      const moduleRootDir = resolve(`dist/${item.root}`);
+      shelljs.rm('-rf', `${moduleRootDir}/*`, { silent: true });
+      // 解决微信开发者工具（dist/app.json: ["subpackages"][0]["root"] 字段需为 目录）错误 - 提前创建该目录
+      // io.ensureDirExist(moduleRootDir);
     }
-    // 判断源码目录是否有该模块
-    if (item.path && !fs.existsSync(resolve(item.path))) {
-      fail(`${item.path}模块代码路径不存在, 请检查tms.config.js的${item.name}模块的path`);
-      process.exit(1);
-    }
-  }
-
-  //  判断package.json的版本是否有新的版本
-  return checkDependencies(targetModules, resolve('./'), tmsConfig.webpack.outputDir);
+  });
 }
 
 async function dev(tmsConfig, targetModules, env) {
-  // tms.config.js的modules 合并 module.config.json的配置项
-  let newModules = tmsModulesMergeLocalModuleCfg(targetModules, tmsConfig.appName, DEFAULT_MODULE_DIR);
+  let newModules = targetModules;
+  const isLatest = global.getData('cmd').latest;
 
   // 判断是否进行init命令
-  if (isInit(tmsConfig, newModules, resolve('dist'))) {
-    // init函数会将 最新的tms.config.js的modules 合并 module.config.json的配置项 返回，不需要再做重复工作
-    const initData = await init(tmsConfig, targetModules);
+  if (isLatest || isInit(tmsConfig, targetModules, resolve('dist'))) {
+    // init函数 下载第三方代码后，会将最新的tms.config.js的modules 合并 module.config.json的配置项返回
+    const initData = await init(tmsConfig, newModules);
     newModules = initData.targetModules;
   }
 
-  console.log('当前dev启动的有效模块', newModules.map(item => item.name));
-  webpackServer(tmsConfig, newModules, env);
+  info('当前dev启动的有效模块', newModules.map(item => item.name).sort());
+  delOtherModule(tmsConfig, newModules);
+  compileDev(tmsConfig, newModules, env);
 }
 
 module.exports = dev;

package/src/scripts/run/index.js

@@ -2,58 +2,92 @@ const init = require('./init/index');
 const dev = require('./dev/index');
 const build = require('./build/index');
 const install = require('./install/index');
-const { createTask, resolve  } = require('../../utils/widgets');
-const { MODE } = require('../../config/constant');
-const { readTmsConfig, checkModules } = require('../../utils/tkitUtils');
+const { global } = require('../../utils/global');
+const {
+  readTmsConfig,
+  readTmsPrivateCf,
+  checkModules,
+  tmsModulesMergeLocalModuleCfg,
+  subModulesMergeDepModules,
+} = require('../../core/tmsMpconfig');
 
-const handleModulesArg = (cmd) => {
-  // 主模块开发
-  if (cmd.module === MODE.main) {
-    return MODE.main;
+const handleModuleArg = (cmd) => {
+  // 单模块或多模块开发-用户通过脚手架参数指定的模块
+  if (typeof cmd.module === 'string') {
+    return cmd.module.split(',');
   }
-  // 单模块 或 多模块开发
-  if (cmd.module) {
-    return [
-      cmd.module,
-      ...cmd.args,
-    ];
+  return [];
+};
+/**
+ * 获取用户指定要跑的模块
+ * @param {Array} moduleArg 参数指定的模块
+ * @param {Object} modulePrivateCfg 私有配置里的模块
+ * @param {Array} moduleAll 当前小程序全部模块
+ */
+const getSpecificModules = (moduleArg, modulePrivateCfg, moduleAll) => {
+  if (moduleArg.length > 0) {
+    return moduleArg;
+  }
+  // 单模块或多模块开发-用户在tms.private.js指定的模块
+  if (modulePrivateCfg) {
+    if (modulePrivateCfg.include?.length > 0) {
+      return modulePrivateCfg.include;
+    }
+    if (modulePrivateCfg.exclude?.length > 0) {
+      return moduleAll.filter(module => !modulePrivateCfg.exclude.includes(module.name)).map(item => item.name);
+    }
+    if (modulePrivateCfg.blockRemote === true) {
+      return moduleAll.filter(module => module.repoInfo === undefined).map(item => item.name);
+    }
   }
-  // 全量模块
-  return MODE.all;
+  return moduleAll.map(item => item.name);
 };
 
 async function run(commandName, cmd) {
-  if (commandName === 'install') {
-    install(resolve('./'));
-    return;
-  }
+  // 用户本地的私有项目配置（用来配置环境\模块信息\账号信息）
+  const tmsPrivateCf = readTmsPrivateCf();
+  const { env = tmsPrivateCf?.env } = cmd;
+  const tmsConfig = readTmsConfig(env);
+  // 处理module参数
+  const specificModules = getSpecificModules(
+    handleModuleArg(cmd),
+    tmsPrivateCf.modules,
+    tmsConfig.modules,
+  );
 
-  const moduleArg = handleModulesArg(cmd);
-  const { env } = cmd;
+  const modules = checkModules(tmsConfig, [
+    ...new Set([
+      ...tmsConfig.mainPackages,
+      ...specificModules,
+    ]),
+  ]);
 
-  const tmsConfig = await createTask(readTmsConfig, '开始读取脚手架的配置项', '读取脚手架的配置项完成')(env);
+  // tms.config.js的modules 合并 module.config.json的配置项
+  let newModules = tmsModulesMergeLocalModuleCfg(modules, tmsConfig.appName);
+  // A分包依赖了B分包的代码， merge B分包进行编译；
+  newModules = subModulesMergeDepModules(tmsConfig, newModules);
 
-  let modules;
-  // 主模块
-  if (moduleArg === MODE.main) {
-    modules = checkModules(tmsConfig, [...new Set([...tmsConfig.mainPackages])]);;
-  } else if (moduleArg === MODE.all) {
-    // 全量模块
-    modules = tmsConfig.modules;
-  } else {
-    // 检查用户输入modules的有效性
-    modules = checkModules(tmsConfig, [...new Set([...tmsConfig.mainPackages, ...moduleArg])]);;
-  }
+  // 缓存数据
+  global.setData({
+    env,
+    cmd,
+    tmsPrivateCf,
+  });
 
   switch (commandName) {
     case 'init':
-      init(tmsConfig, modules, env);
+      init(tmsConfig, newModules, env);
       return;
     case 'dev':
-      dev(tmsConfig, modules, env);
+      global.setData('isDev', true);
+      dev(tmsConfig, newModules, env);
+      return;
+    case 'install':
+      install(tmsConfig, newModules, env);
       return;
     case 'build':
-      build(tmsConfig, modules, env);
+      global.setData('isDev', false);
+      build(tmsConfig, newModules, env);
       return;
     default:
       return;