@tmsfe/tmskit 0.0.17 → 0.0.18

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tmsfe/tmskit",
-  "version": "0.0.17",
+  "version": "0.0.18",
   "description": "tmskit",
   "main": "dist/index.cjs",
   "bin": {

package/src/compile/dev.js

@@ -3,7 +3,7 @@ const fs = require('fs');
 const ora = require('ora');
 const chalk = require('chalk');
 const { parallel, series } = require('gulp');
-const { resolve, mergeMap } = require('../utils/widgets');
+const { resolve, mergeMap, filterField } = require('../utils/widgets');
 const { buildOutputAppJson } = require('../core/buildAppJson');
 const { DEFAULT_COPY_CONFIG } = require('../config/constant');
 const compile = require('./compile');
@@ -154,7 +154,11 @@ module.exports = async (tmsConfig, newModules, isDev = true) => {
     }
     eTime = new Date().getTime() - sTime;
     if (typeof tmsConfig?.hooks?.afterCompile === 'function') {
-      await tmsConfig?.hooks?.afterCompile({ isDev, tmsConfig, modules: newModules });
+      await tmsConfig?.hooks?.afterCompile({
+        isDev,
+        tmsConfig: filterField(tmsConfig, ['gitAccount']),
+        modules: newModules,
+      });
     }
     spinner.succeed(chalk.green(`首次编译完成, 耗时${eTime / 1000}s, 微信开发者工具打开项目即可预览。`));
     spinner.stop();

package/src/config/constant.js

@@ -14,7 +14,7 @@ const TEMPLATE_DIR = path.resolve(CACHE_DIR, 'template');
 const MODULE_CODE_DIR = path.resolve(CACHE_DIR, 'modules_code');
 
 // 脚手架模板代码的具体路径
-const TEMPLATE_PATH = path.resolve(TEMPLATE_DIR, 'tools/tms-cli-template');
+const TEMPLATE_PATH = path.resolve(TEMPLATE_DIR, 'tools/tmskit-template');
 
 // 脚手架的名称
 const TMS_NAME = 'tmskit';
@@ -47,7 +47,6 @@ const ENV = {
 };
 
 const  TEMPLATE_TKIT_DIR = '_tmskit';
-const MODULE_CONFIG_INVALID_KEY = ['entranceDeclare', 'entryPagePath'];
 
 export {
   HOME_DIR,
@@ -64,6 +63,5 @@ export {
   MODULE_CODE_DIR,
   ENV,
   TEMPLATE_TKIT_DIR,
-  MODULE_CONFIG_INVALID_KEY,
   DEFAULT_CLOUD_MODULE_DIR,
 };

package/src/config/defaultTmsConfig.js

@@ -3,7 +3,7 @@ module.exports = {
   // 全局的环境配置项
   envData: {},
   // 模块配置信息
-  modules: [],
+  modules: {},
   cloudDir: 'cloud',
   // 第三方依赖代码需要拷贝到本项目的
   dependencies: {},

package/src/core/buildAppJson.js

@@ -3,10 +3,10 @@
  */
 /* eslint-disable no-param-reassign */
 const fs = require('fs');
-const { MODULE_CONFIG_FILENAME, MODULE_CONFIG_INVALID_KEY } = require('../config/constant');
+const { MODULE_CONFIG_FILENAME } = require('../config/constant');
 const { getModuleConfig } = require('./tmsMpconfig');
 const { fail } = require('../utils/log');
-const { resolve, isObject } = require('../utils/widgets');
+const { resolve, isObject, filterField } = require('../utils/widgets');
 const { handleError } = require('./handleError');
 const { global } = require('../utils/global');
 
@@ -56,8 +56,6 @@ const getAppJsonContent = (sourceAppJsonPath) => {
   // 加入默认值
   appJson.subpackages = [];
   appJson.pages = [];
-  // appJson.plugins = {};
-  delete appJson.entranceDeclare;
   return appJson;
 };
 /**
@@ -83,37 +81,35 @@ const fixAppJson = (appJson) => {
   const pluginsMap = {};
   Object.keys(appJson.plugins || {}).forEach(key => pluginsMap[key] = ['app.json']);
   const subps = subpackages.map((subp) => {
-    const invalidKeys = [];
+    const arrOfFileType = ['requiredBackgroundModes', 'embeddedAppIdList'];
+    const objOfFileType = ['preloadRule'];
     Object.keys(subp).forEach((key) => {
-      if (key === 'dependencies') {
-        // eslint-disable-next-line
-        delete subp.dependencies;
-        return;
-      }
       if (key === 'plugins') {
         Object.keys(subp.plugins).forEach((pk) => {
-          pluginsMap[pk] ? pluginsMap[pk].push(`分包${subp.name}`) : pluginsMap[pk] = [`分包${subp.name}`];
+          pluginsMap[pk]
+            ? pluginsMap[pk].push(`分包${subp.name}`)
+            : pluginsMap[pk] = [`分包${subp.name}`];
         });
-        return;
-      }
-      if (MODULE_CONFIG_INVALID_KEY.indexOf(key) > -1) {
-        // 如果分包配置中有不支持的key，则错误提醒
-        invalidKeys.push(key);
-        return;
       }
-      if (['requiredBackgroundModes', 'embeddedAppIdList'].indexOf(key) > -1) {
-        // 提到appjson最上层处理
+      // 分包里数组类型字段，提到appjson最上层
+      if (arrOfFileType.indexOf(key) > -1) {
         const preVal = appJson[key];
-        preVal ? appJson[key] = Array.from(new Set(preVal
-          .slice(0).concat(subp[key]))) : appJson[key] = subp[key].slice(0);
-        return;
+        preVal
+          ? appJson[key] = Array.from(new Set(preVal.slice(0).concat(subp[key])))
+          : appJson[key] = subp[key].slice(0);
+      }
+      // 分包里对象类型字段，提到appjson最上层
+      if (objOfFileType.indexOf(key) > -1) {
+        const preloadRuleMap = appJson[key] || {};
+        subp[key] && Object.keys(subp[key]).forEach((page) => {
+          if (!preloadRuleMap[page]) {
+            preloadRuleMap[page] = subp[key][page];
+          }
+        });
+        appJson[key] = preloadRuleMap;
       }
     });
-    if (invalidKeys.length) {
-      fail(`不支持分包${subp?.name}配置${invalidKeys.join(',')}\n`);
-    }
-    invalidKeys.concat(['requiredBackgroundModes', 'embeddedAppIdList']).forEach(k => delete subp[k]);
-    return subp;
+    return filterField(subp, [...arrOfFileType, ...objOfFileType, 'dependencies']);
   });
   // 如果plugins重复，则错误提示
   const pluginsErrMsg = Object.keys(pluginsMap).map((pk) => {
@@ -124,7 +120,7 @@ const fixAppJson = (appJson) => {
   })
     .reduce((pre, cur) => pre + cur, '');
   if (pluginsErrMsg) {
-    fail(`plugins配置出现错误:${pluginsErrMsg}`);
+    throw new Error(`plugins配置出现错误:${pluginsErrMsg}`);
   }
   appJson.subpackages = subps;
 };
@@ -149,12 +145,15 @@ function buildOutputAppJson(tmsConfig, modules) {
     updateMainPackages(appJson, tmsConfig.mainPackages);
 
     fs.writeFileSync(resolve(`${tmsConfig.outputDir}/app.json`), JSON.stringify(appJson, null, 2), 'utf8');
+
     if (typeof tmsConfig?.hooks?.updateAppJson === 'function') {
       tmsConfig?.hooks?.updateAppJson({
-        tmsConfig, module, appJson, isDev: global.getData('isDev'),
+        tmsConfig: filterField(tmsConfig, ['gitAccount']),
+        modules,
+        appJson,
+        isDev: global.getData('isDev'),
       });
     }
-
     return appJson;
   } catch (e) {
     handleError(`生成app.json出现错误: ${e}`);

package/src/core/cloneModules.js

@@ -18,11 +18,11 @@ const { global } = require('../utils/global');
  */
 function replaceGitUrlAccount(httpRepoUrl, moduleName) {
   // 用户本地的私有项目配置（用来配置环境\模块信息\账号信息）
-  const tmsPrivateCf = global.getData('tmsPrivateCf');
+  const tmsConfig = global.getData('tmsConfig');
 
   let gitUrl = httpRepoUrl;
-  const { username = '', pass = '' } = tmsPrivateCf?.gitAccout?.[moduleName]
-    || tmsPrivateCf?.gitAccount?.[moduleName]
+  const { username = '', pass = '' } = tmsConfig?.gitAccout?.[moduleName]
+    || tmsConfig?.gitAccount?.[moduleName]
     || {};
 
   const urlPrefixReg = /http(s)?:\/\//;

package/src/core/tmsMpconfig.js

@@ -7,7 +7,6 @@ const { TMS_CONFIG_FILENAME, MODULE_CONFIG_FILENAME, TMS_PRIVATE_FILENAME } = re
 const { resolve, isObject, isArray } = require('../utils/widgets');
 const defaultTmsConfig = require('../config/defaultTmsConfig');
 const { fail } = require('../utils/log');
-const path = require('path');
 
 /**
  * 读取tms.config.js
@@ -26,32 +25,9 @@ const readTmsConfig = function (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
@@ -62,12 +38,7 @@ const readTmsPrivateCf = function () {
   if (fs.existsSync(tmsPrivatePath)) {
     tmsPrivateCf = require(tmsPrivatePath);
   }
-  // 处理modules字段
-  if (tmsPrivateCf.modules instanceof Array) {
-    Object.assign(tmsPrivateCf.modules, {
-      include: tmsPrivateCf.modules,
-    });
-  }
+
   return tmsPrivateCf;
 };
 
@@ -80,11 +51,10 @@ const readTmsPrivateCf = function () {
 const checkModules = function (tmsConfig, modules, isQuit = false) {
   const targetModules = [];
   modules.forEach((moduleName) => {
-    const module = tmsConfig.modules.find(module => module.name === moduleName);
+    const module = tmsConfig.modules.all.find(module => module.name === moduleName);
     module && targetModules.push(module);
   });
 
-
   if (targetModules.length === 0) {
     fail(`你启动的模块无效${modules.join(',')}无效，请检查tms.config.json>modules>${modules.join(',')}
     >name字段与module.config.json的name字段是否一致`);
@@ -119,11 +89,6 @@ function adaptMpCgContent(fileContent, appName) {
       i--; // eslint-disable-line
     }
   } else {
-    if (appName && content.mpConfig && content.mpConfig[appName]) {
-      content = { ...content, ...content.mpConfig[appName] };
-      delete content.mpConfig;
-      delete content.isSubpackages;
-    }
     content = handleContent(appName, content);
   }
   return content;

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

@@ -1,5 +1,5 @@
 const shelljs = require('shelljs');
-const { resolve } = require('../../../utils/widgets');
+const { resolve, filterField } = require('../../../utils/widgets');
 const init = require('../init/index');
 const compileBuild = require('../../../compile/build');
 
@@ -10,7 +10,10 @@ async function build(tmsConfig, targetModules, env) {
   const { targetModules: newModules } = await init(tmsConfig, targetModules);
 
   if (typeof tmsConfig?.hooks?.beforeCompile === 'function') {
-    await tmsConfig?.hooks?.beforeCompile({ isDev: false, tmsConfig, modules: newModules });
+    await tmsConfig?.hooks?.beforeCompile({
+      isDev: false,
+      tmsConfig: filterField(tmsConfig, ['gitAccount']),
+      modules: newModules });
   };
   compileBuild(tmsConfig, newModules, env);
 }

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

@@ -1,6 +1,6 @@
 const shelljs = require('shelljs');
 const compileDev = require('../../../compile/dev');
-const { resolve } = require('../../../utils/widgets');
+const { resolve, filterField } = require('../../../utils/widgets');
 const init = require('../init/index');
 const { tmsModulesMergeLocalModuleCfg } = require('../../../core/tmsMpconfig');
 const { info } = require('../../../utils/log');
@@ -10,7 +10,7 @@ const { CACHE_DIR } = require('../../../config/constant');
 
 // 用户编译分包时，需要将dist中其他分包(主包不能删除)的内容删除，否则其他分包的内容混入到主包(导致主包的体积超2M)
 function delOtherModule(tmsConfig, targetModules) {
-  const modules = tmsModulesMergeLocalModuleCfg(tmsConfig.modules, tmsConfig.appName);
+  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) {
@@ -36,7 +36,11 @@ async function dev(tmsConfig, targetModules, env) {
 
   info('当前dev启动的有效模块', newModules.map(item => item.name).sort());
   if (typeof tmsConfig?.hooks?.beforeCompile === 'function') {
-    await tmsConfig?.hooks?.beforeCompile({ isDev: true, tmsConfig, modules: newModules });
+    await tmsConfig?.hooks?.beforeCompile({
+      isDev: true,
+      tmsConfig: filterField(tmsConfig, ['gitAccount']),
+      modules: newModules,
+    });
   };
   delOtherModule(tmsConfig, newModules);
   compileDev(tmsConfig, newModules, env);

package/src/scripts/run/index.js

@@ -1,3 +1,5 @@
+/* eslint-disable no-param-reassign */
+const loadash = require('lodash');
 const init = require('./init/index');
 const dev = require('./dev/index');
 const build = require('./build/index');
@@ -25,34 +27,50 @@ const handleModuleArg = (cmd) => {
  * @param {Object} modulePrivateCfg 私有配置里的模块
  * @param {Array} moduleAll 当前小程序全部模块
  */
-const getSpecificModules = (moduleArg, modulePrivateCfg, moduleAll) => {
+const getSpecificModules = (moduleArg, modules) => {
   if (moduleArg.length > 0) {
     return moduleArg;
   }
+  const { all, include, exclude, blockRemote } = modules;
   // 单模块或多模块开发-用户在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);
-    }
+  if (include?.length > 0) {
+    return include;
+  }
+  if (exclude?.length > 0) {
+    return all.filter(module => !exclude.includes(module.name)).map(item => item.name);
+  }
+  if (blockRemote === true) {
+    return all.filter(module => module.repoInfo === undefined).map(item => item.name);
+  }
+  return all.map(item => item.name);
+};
+
+const mergeConfig = (tmsConfig, tmsPrivateCf) => {
+  const modules = {};
+  if (Array.isArray(tmsConfig.modules)) {
+    modules.all = tmsConfig.modules;
+    tmsConfig.modules = modules;
   }
-  return moduleAll.map(item => item.name);
+  // 合并默认值
+  const res = loadash.mergeWith(tmsConfig, tmsPrivateCf, (objValue, srcValue) => {
+    if (loadash.isArray(objValue) && objValue[0] && loadash.isObject(objValue[0])) {
+      return objValue.concat(srcValue);
+    }
+  });
+
+  return res;
 };
 
 async function run(commandName, cmd) {
-  // 用户本地的私有项目配置（用来配置环境\模块信息\账号信息）
+  // 用户本地的私有项目配置
   const tmsPrivateCf = readTmsPrivateCf();
   const { env = tmsPrivateCf?.env } = cmd;
-  const tmsConfig = readTmsConfig(env);
+  let tmsConfig = readTmsConfig(env);
+  tmsConfig = mergeConfig(tmsConfig, tmsPrivateCf);
+
   // 处理module参数
   const specificModules = getSpecificModules(
     handleModuleArg(cmd),
-    tmsPrivateCf.modules,
     tmsConfig.modules,
   );
 
@@ -76,7 +94,6 @@ async function run(commandName, cmd) {
   global.setData({
     env,
     cmd,
-    tmsPrivateCf,
     tmsConfig,
   });
 

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

@@ -5,7 +5,6 @@ const { createTask, resolve } = require('../../../utils/widgets');
 const { buildMpNpm } = require('../../../core/mpCi');
 const { CACHE_DIR } = require('../../../config/constant');
 const { mpNpmInstallAll } = require('../../../core/npm');
-const { global } = require('../../../utils/global');
 const { fail } = require('../../../utils/log');
 
 async function install(tmsConfig, modules) {
@@ -28,13 +27,12 @@ async function install(tmsConfig, modules) {
     '小程序npm install 完成',
   )(modules, resolve(tmsConfig.outputDir), `${CACHE_DIR}/node_modules`);
 
-  const tmsPrivateCf = global.getData('tmsPrivateCf');
   // 构建miniprogram_npm
   await createTask(
     buildMpNpm,
     '开始构建miniprogram_npm',
     '构建miniprogram_npm 完成',
-  )({ appId: tmsConfig.appId, projectPath: resolve('./'), privateKey: tmsPrivateCf.privateKey });
+  )({ appId: tmsConfig.appId, projectPath: resolve('./'), privateKey: tmsConfig.privateKey });
 }
 
 module.exports = install;

package/src/utils/widgets.js

@@ -180,6 +180,22 @@ const relativeCwdPath = function (file) {
   return path.relative(process.cwd(), file);
 };
 
+/**
+ * 从一个对象中，检索出去几个字段
+ * @param {*} obj
+ * @param {*} name
+ * @returns
+ */
+const filterField = (obj, filterNames = []) => {
+  const newObj = { ...obj };
+  filterNames.forEach((name) => {
+    if (newObj[name]) {
+      delete newObj[name];
+    }
+  });
+  return newObj;
+};
+
 module.exports = {
   resolve,
   isObject,
@@ -192,4 +208,5 @@ module.exports = {
   npmInstall,
   mergeMap,
   relativeCwdPath,
+  filterField,
 };