@tmsfe/tmskit 0.0.19 → 0.0.22

package/src/scripts/create/index.js

@@ -1,18 +1,28 @@
 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');
+const report = require('../../core/report');
 
 /**
  * 如果该目录下面存在文件，换个名字
  * @param { string } targetDir 当前文件夹
  * @returns { undefined }
  */
-async function createAppDir(targetDir) {
+async function createProjectDir(targetDir) {
   // 如果目录非空或者已经存在，提示用户，做选择
   if (fs.existsSync(targetDir)) {
     if (!await io.isDirEmpty(targetDir)) {
@@ -24,43 +34,76 @@ 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);
+  report('create-start', { projectType });
 
-  // 创建缓存目录
-  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));
+    report('create-success', { projectType });
     succeed('项目创建完成.');
   })
     .catch((err) => {

package/src/scripts/extend-cmd/index.js

@@ -0,0 +1,74 @@
+
+const fs = require('fs');
+const path = require('path');
+const shellJs = require('shelljs');
+const { ensureDirExist } = require('../../utils/io');
+const { EXTEND_CMD } = require('../../config/constant');
+const { createTask } = require('../../utils/widgets');
+const { info, fail } = require('../../utils/log');
+
+/**
+ * 下载扩展命令的npm包
+ * @param {string} npmName npm包名
+ * @param {object} cmd  {registry: 'http://mirrors.tencent.com/npm/'} 用户输入执行install-cmd的参数
+ */
+async function installCmd(npmName, cmd) {
+  try {
+    const cmdPackageJson = `${EXTEND_CMD}/package.json`;
+    if (!fs.existsSync(cmdPackageJson)) {
+      ensureDirExist(EXTEND_CMD);
+      fs.writeFileSync(cmdPackageJson, JSON.stringify({ dependencies: {} }, null, 2));
+    }
+    shellJs.cd(EXTEND_CMD);
+    await createTask(npmName => new Promise((resolve, reject) => {
+      const registry = cmd.registry ? `--registry=${cmd.registry}` : '';
+      shellJs.exec(
+        `npm install --save ${npmName} ${registry}`,
+        { cwd: EXTEND_CMD, silent: true },
+        (code, stdout, stderr) => {
+          if (code !== 0) {
+            reject(stderr);
+          }
+          resolve();
+        },
+      );
+    }), `开始下载${npmName}`, `下载${npmName}完成`)(npmName);
+  } catch (e) {
+    fail('构建出现错误:');
+    info(e);
+    process.exit(1);
+  }
+}
+
+
+/**
+ * 加载扩展命令的npm包
+ * @returns
+ */
+function loadExtendCmd() {
+  const cmdPackageJson = `${EXTEND_CMD}/package.json`;
+  const cmdNpmDir = `${EXTEND_CMD}/node_modules`;
+  if (fs.existsSync(cmdPackageJson)) {
+    const content = fs.readFileSync(cmdPackageJson, 'utf8');
+    const json = JSON.parse(content);
+    const deps = json.dependencies || {};
+
+    const cmdConfigs = [];
+    Object.keys(deps).forEach((name) => {
+      // 检索cmd的npm包
+      if (!/^tmskit-cmd-|^@[^/]+\/tmskit-cmd-/.test(name)) return false;
+      const cmdConfig = path.join(cmdNpmDir, name, 'tms.config.js');
+      if (fs.existsSync(cmdConfig)) {
+        cmdConfigs.push(cmdConfig);
+      }
+    });
+    return cmdConfigs;
+  }
+  return [];
+}
+
+
+module.exports = {
+  installCmd,
+  loadExtendCmd,
+};

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

@@ -2,20 +2,23 @@ const shelljs = require('shelljs');
 const { resolve, filterField } = require('../../../utils/widgets');
 const init = require('../init/index');
 const compileBuild = require('../../../compile/build');
+const report = require('../../../core/report');
 
-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 });
+    report('hooks:beforeCompile');
   };
-  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}`);
   }

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

@@ -2,18 +2,23 @@ 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');
+const { MODULE_CODE_DIR, NODE_MODULES_DIR } = require('../../../config/constant');
+const report = require('../../../core/report');
+const { recommendVersion } = require('../../../core/recommendVersion');
 
 
 // 用户编译分包时，需要将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,28 +27,30 @@ 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));
-    shelljs.rm('-rf', CACHE_DIR);
+    shelljs.rm('-rf', MODULE_CODE_DIR);
+    shelljs.rm('-rf', NODE_MODULES_DIR);
   }
+  // 推荐tmskit的版本
+  await recommendVersion();
 
   // 初始化操作
-  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,
       tmsConfig: filterField(tmsConfig, ['gitAccount']),
       modules: newModules,
     });
+    report('hooks:beforeCompile');
   };
-  delOtherModule(tmsConfig, newModules);
-  compileDev(tmsConfig, newModules, env);
+  delOtherPackages(tmsConfig, subPackages);
+  compileDev(tmsConfig, newModules, true);
 }
 
 module.exports = dev;

package/src/scripts/run/index.js

@@ -1,17 +1,17 @@
 /* eslint-disable no-param-reassign */
-const loadash = require('lodash');
 const init = require('./init/index');
 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 report = require('../../core/report');
 const {
-  readTmsConfig,
-  readTmsPrivateCf,
-  checkModules,
-  tmsModulesMergeLocalModuleCfg,
-  subModulesMergeDepModules,
+  getTmsConfig,
+  getModulesByMergeDepModules,
+  getSubPackages,
+  getModulesByModuleNames,
 } = require('../../core/tmsMpconfig');
 
 const handleModuleArg = (cmd) => {
@@ -27,7 +27,7 @@ const handleModuleArg = (cmd) => {
  * @param {Object} modulePrivateCfg 私有配置里的模块
  * @param {Array} moduleAll 当前小程序全部模块
  */
-const getSpecificModules = (moduleArg, modules) => {
+const getSpecificModuleNames = (moduleArg, modules) => {
   if (moduleArg.length > 0) {
     return moduleArg;
   }
@@ -37,83 +37,73 @@ 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);
-};
-
-const mergeConfig = (tmsConfig, tmsPrivateCf) => {
-  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;
+  return all.map(item => item.moduleName);
 };
 
 async function run(commandName, cmd) {
-  // 用户本地的私有项目配置
-  const tmsPrivateCf = readTmsPrivateCf();
-  const { env = tmsPrivateCf?.env } = cmd;
-  let tmsConfig = readTmsConfig(env);
-  tmsConfig = mergeConfig(tmsConfig, tmsPrivateCf);
+  // 用户本地的配置
+  const tmsConfig = getTmsConfig();
+  try {
+    // 缓存数据
+    global.setData({
+      cmd,
+      tmsConfig,
+    });
 
+    if (commandName === 'cloud') {
+      cloud(tmsConfig);
+      report('run:cloud', { appName: tmsConfig?.appName });
+      return;
+    }
+    otherCommands(tmsConfig, commandName, cmd);
+  } catch (error) {
+    const errMsg = typeof error === 'object' ? error.message : error;
+    report('run', { errMsg, appName: tmsConfig?.appName });
+    fail(`构建出现错误: ${errMsg}`);
+    info('详细错误信息', error);
+    process.exit(1);
+  }
+}
+
+function otherCommands(tmsConfig, commandName, cmd) {
   // 处理module参数
-  const specificModules = getSpecificModules(
+  const specificModuleNames = getSpecificModuleNames(
     handleModuleArg(cmd),
     tmsConfig.modules,
   );
 
-  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);
+  // moduleNames => ['home', 'car']
+  const moduleNames = [...new Set([...specificModuleNames])];
+  const modules = getModulesByModuleNames(tmsConfig, moduleNames, false);
 
-  // 缓存数据
-  global.setData({
-    env,
-    cmd,
-    tmsConfig,
-  });
+  // 获取所有模块，合并模块依赖的模块
+  const newModules = getModulesByMergeDepModules(tmsConfig, modules, false);
+  // 获取所有的分包
+  const subPackages = getSubPackages(newModules);
 
   switch (commandName) {
     case 'init':
-      init(tmsConfig, newModules, env);
+      init(tmsConfig, newModules);
+      report('run:init', { appName: tmsConfig?.appName });
       return;
     case 'dev':
       global.setData('isDev', true);
-      dev(tmsConfig, newModules, env);
-      return;
-    case 'cloud':
-      cloud(tmsConfig, env);
+      dev(tmsConfig, newModules);
+      report('run:dev', { appName: tmsConfig?.appName });
       return;
     case 'install':
-      install(tmsConfig, newModules, env, false);
+      install(tmsConfig, subPackages, false);
+      report('run:install', { appName: tmsConfig?.appName });
       return;
     case 'build':
       global.setData('isDev', false);
-      build(tmsConfig, newModules, env);
+      build(tmsConfig, newModules);
+      report('run:build', { appName: tmsConfig?.appName });
       return;
     default:
       return;

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

@@ -5,7 +5,7 @@ const { resolve, createTask } = require('../../../utils/widgets');
 const { buildOutputAppJson } = require('../../../core/buildAppJson');
 const { MODULE_CODE_DIR, DEFAULT_COPY_CONFIG } = require('../../../config/constant');
 const { cloneModules } = require('../../../core/cloneModules');
-const { tmsModulesMergeLocalModuleCfg, subModulesMergeDepModules } = require('../../../core/tmsMpconfig');
+const { getModulesByMergeDepModules, getSubPackages } = require('../../../core/tmsMpconfig');
 const { fail, info } = require('../../../utils/log');
 const install = require('../install');
 
@@ -26,25 +26,6 @@ const cpFilesToOutput = function (tmsConfig, defaultFiles) {
   });
 };
 
-/**
- * 校验相关配置项
- * @param {*} targetModules
- * @returns
- */
-function checkConfig(targetModules) {
-  for (const item of targetModules) {
-    if (!item.root) {
-      throw new Error(`检查${item.name} module.config.json的root字段`);
-    }
-
-    // 判断源码目录是否有该模块
-    if (item.path && !fs.existsSync(resolve(item.path))) {
-      throw new Error(`${item.path}模块代码路径不存在, 请检查tms.config.js的${item.name}模块的path`);
-    }
-  }
-  return true;
-}
-
 async function task(tmsConfig, targetModules) {
   // 下载和移动代码
   await createTask(
@@ -53,12 +34,10 @@ async function task(tmsConfig, targetModules) {
     '下载模块代码码完成',
   )(MODULE_CODE_DIR, resolve('./'), targetModules);
 
-  // tms.config.js的modules 合并 module.config.json的配置项
-  let newModules = tmsModulesMergeLocalModuleCfg(targetModules, tmsConfig.appName);
-  // A分包依赖了B分包的代码， merge B分包进行编译；
-  newModules = subModulesMergeDepModules(tmsConfig, newModules);
-
-  checkConfig(newModules);
+  // 获取所有模块，合并模块依赖的模块
+  const newModules = getModulesByMergeDepModules(tmsConfig, targetModules, true);
+  // 获取所有的分包
+  const newSubPackages = getSubPackages(newModules);
 
   // 拷贝相关配置文件到输出目录
   await createTask(
@@ -68,8 +47,7 @@ async function task(tmsConfig, targetModules) {
   )(tmsConfig, DEFAULT_COPY_CONFIG);
 
   // install
-  await install(tmsConfig, newModules);
-
+  await install(tmsConfig, newSubPackages, true);
 
   // 动态生成编译后的app.json;
   await createTask(
@@ -78,18 +56,19 @@ async function task(tmsConfig, targetModules) {
     '生成编译后的app.json完成',
   )(tmsConfig, newModules);
 
-  return newModules;
+  return {
+    modules: newModules,
+    subPackages: newSubPackages,
+  };
 }
 async function init(tmsConfig, targetModules) {
   try {
-    const newModules = await task(tmsConfig, targetModules);
+    const taskRes = await task(tmsConfig, targetModules);
 
-    return {
-      targetModules: newModules,
-    };
+    return taskRes;
   } catch (error) {
     const errMsg = typeof error === 'object' ? error.message : error;
-    fail(`初始化流程出现错误${errMsg}`);
+    fail(`初始化流程出现错误: ${errMsg}`);
     info('详细的错误信息', error);
     process.exit(1);
   }

package/src/{core → scripts/run/install}/cache.js

@@ -1,10 +1,10 @@
 const fs = require('fs');
 const path = require('path');
-const { CACHE_FILE, CACHE_DIR } = require('../config/constant');
-const { ensureDirExist } = require('../utils/io');
+const { NPM_CACHE_FILE } = require('../../../config/constant');
+const { ensureDirExist } = require('../../../utils/io');
 
 function getCache(projectDir, type) {
-  const filePath = `${CACHE_DIR}/${CACHE_FILE}`;
+  const filePath = NPM_CACHE_FILE;
   if (!fs.existsSync(filePath)) {
     return null;
   }
@@ -14,7 +14,7 @@ function getCache(projectDir, type) {
 
 
 function setCache(projectDir, type = 'miniprogram_npm', data) {
-  const filePath = `${CACHE_DIR}/${CACHE_FILE}`;
+  const filePath = NPM_CACHE_FILE;
   if (!fs.existsSync(filePath)) {
     const dir = path.dirname(filePath);
     ensureDirExist(dir);