@tmsfe/tmskit 0.0.6 → 0.0.9-beta.0

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

@@ -1,54 +1,12 @@
-const gulpDev = require('../../../gulp/dev');
-const fs = require('fs');
+const shelljs = require('shelljs');
+const compileDev = require('../../../compile/dev');
 const { resolve } = require('../../../utils/widgets');
 const init = require('../init/index');
-const { MODULE_CONFIG_FILENAME } = require('../../../config/constant');
-const { tmsModulesMergeLocalModuleCfg } = require('../../../utils/tkitUtils');
-const { checkDependencies } = require('../../../utils/checkDependencies');
-const { fail } = require('../../../utils/log');
-const shelljs = require('shelljs');
-// const io = require('../../../utils/io');
-
-function isInit(tmsConfig, targetModules, contextDir, isDev) {
-  // 判断是否存在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;
-  }
+const { isInit } = require('../../../core/isInIt');
+const { tmsModulesMergeLocalModuleCfg } = require('../../../core/tmsMpconfig');
+const { info } = require('../../../utils/log');
+const { global } = require('../../../utils/global');
 
-  // 判断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;
-    }
-    // 判断dist目录是否有该模块
-    if (!fs.existsSync(`${contextDir}/${item.root}/${MODULE_CONFIG_FILENAME}`)) {
-      return true;
-    }
-    // 判断源码目录是否有该模块
-    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.outputDir, isDev);
-}
 
 // 用户编译分包时，需要将dist中其他分包(主包不能删除)的内容删除，否则其他分包的内容混入到主包(导致主包的体积超2M)
 function delOtherModule(tmsConfig, targetModules) {
@@ -66,18 +24,18 @@ function delOtherModule(tmsConfig, targetModules) {
 
 async function dev(tmsConfig, targetModules, env) {
   let newModules = targetModules;
-  const isDev = true;
+  const isLatest = global.getData('cmd').latest;
 
   // 判断是否进行init命令
-  if (isInit(tmsConfig, targetModules, resolve('dist'), isDev)) {
+  if (isLatest || isInit(tmsConfig, targetModules, resolve('dist'))) {
     // init函数 下载第三方代码后，会将最新的tms.config.js的modules 合并 module.config.json的配置项返回
-    const initData = await init(tmsConfig, newModules, isDev);
+    const initData = await init(tmsConfig, newModules);
     newModules = initData.targetModules;
   }
 
-  console.log('当前dev启动的有效模块', newModules.map(item => item.name).sort());
+  info('当前dev启动的有效模块', newModules.map(item => item.name).sort());
   delOtherModule(tmsConfig, newModules);
-  gulpDev(tmsConfig, newModules, env);
+  compileDev(tmsConfig, newModules, env);
 }
 
 module.exports = dev;

package/src/scripts/run/index.js

@@ -2,62 +2,91 @@ const init = require('./init/index');
 const dev = require('./dev/index');
 const build = require('./build/index');
 const install = require('./install/index');
-const { createTask } = require('../../utils/widgets');
-const { MODE } = require('../../config/constant');
-const { readTmsConfig, readTmsPrivateCf, checkModules } = require('../../utils/tkitUtils');
-const { tmsModulesMergeLocalModuleCfg, subModulesMergeDepModules } = require('../../utils/tkitUtils');
+const { global } = require('../../utils/global');
+const {
+  readTmsConfig,
+  readTmsPrivateCf,
+  checkModules,
+  tmsModulesMergeLocalModuleCfg,
+  subModulesMergeDepModules,
+} = require('../../core/tmsMpconfig');
 
-const handleModulesArg = (cmd, tmsPrivateCg) => {
+const handleModuleArg = (cmd) => {
   // 单模块或多模块开发-用户通过脚手架参数指定的模块
-  if (cmd.module) {
-    const { argv } = process;
-    const reset = argv.indexOf('-m') > -1 ? argv.slice(argv.indexOf('-m') + 1) : [];
-    return [
-      cmd.module,
-      ...reset,
-    ];
+  if (typeof cmd.module === 'string') {
+    return cmd.module.split(',');
+  }
+  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 (tmsPrivateCg?.modules && tmsPrivateCg?.modules.length > 0) {
-    return tmsPrivateCg?.modules;
+  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) {
   // 用户本地的私有项目配置（用来配置环境\模块信息\账号信息）
-  const tmsPrivateCg = readTmsPrivateCf();
+  const tmsPrivateCf = readTmsPrivateCf();
+  const { env = tmsPrivateCf?.env } = cmd;
+  const tmsConfig = readTmsConfig(env);
   // 处理module参数
-  const moduleArg = handleModulesArg(cmd, tmsPrivateCg);
-  const { env = tmsPrivateCg?.env } = cmd;
-  const tmsConfig = await createTask(readTmsConfig, '开始读取脚手架的配置项', '读取脚手架的配置项完成')(env);
+  const specificModules = getSpecificModules(
+    handleModuleArg(cmd),
+    tmsPrivateCf.modules,
+    tmsConfig.modules,
+  );
 
-  let modules;
-  if (moduleArg === MODE.all) {
-    // 全量模块
-    modules = tmsConfig.modules;
-  } else {
-    // 检查用户输入modules的有效性
-    modules = checkModules(tmsConfig, [...new Set([...tmsConfig.mainPackages, ...moduleArg])]);
-  }
+  const modules = checkModules(tmsConfig, [
+    ...new Set([
+      ...tmsConfig.mainPackages,
+      ...specificModules,
+    ]),
+  ]);
 
   // tms.config.js的modules 合并 module.config.json的配置项
   let newModules = tmsModulesMergeLocalModuleCfg(modules, tmsConfig.appName);
   // A分包依赖了B分包的代码， merge B分包进行编译；
   newModules = subModulesMergeDepModules(tmsConfig, newModules);
 
+  // 缓存数据
+  global.setData({
+    env,
+    cmd,
+    tmsPrivateCf,
+  });
+
   switch (commandName) {
     case 'init':
       init(tmsConfig, newModules, env);
       return;
     case 'dev':
+      global.setData('isDev', true);
       dev(tmsConfig, newModules, env);
       return;
     case 'install':
       install(tmsConfig, newModules, env);
       return;
     case 'build':
+      global.setData('isDev', false);
       build(tmsConfig, newModules, env);
       return;
     default:

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

@@ -2,11 +2,12 @@ const shelljs = require('shelljs');
 const fs = require('fs');
 const io = require('../../../utils/io');
 const { resolve, createTask } = require('../../../utils/widgets');
-const { buildOutputAppJson } = require('../../../utils/buildAppJson');
-const {  MODULE_CODE_DIR, DEFAULT_COPY_CONFIG } = require('../../../config/constant');
-const { cloneModules } = require('../../../utils/cloneModules');
-const { tmsModulesMergeLocalModuleCfg, subModulesMergeDepModules } = require('../../../utils/tkitUtils');
-const { fail } = require('../../../utils/log');
+const { buildOutputAppJson } = require('../../../core/buildAppJson');
+const { symLink } = require('../../../core/symbolicLink');
+const { MODULE_CODE_DIR, DEFAULT_COPY_CONFIG } = require('../../../config/constant');
+const { cloneModules } = require('../../../core/cloneModules');
+const { tmsModulesMergeLocalModuleCfg, subModulesMergeDepModules } = require('../../../core/tmsMpconfig');
+const { fail, info } = require('../../../utils/log');
 const install = require('../install');
 
 /**
@@ -38,13 +39,13 @@ const cpFilesToOutput = function (tmsConfig, targetModules, defaultFiles) {
   });
 };
 
-async function task(tmsConfig, targetModules, isDev) {
+async function task(tmsConfig, targetModules) {
   // 下载和移动代码
   await createTask(
     cloneModules,
-    '开始下载模块代码完成',
+    '开始下载模块代码',
     '下载模块代码码完成',
-  )(MODULE_CODE_DIR, resolve('./'), targetModules, isDev);
+  )(MODULE_CODE_DIR, resolve('./'), targetModules);
 
   // tms.config.js的modules 合并 module.config.json的配置项
   let newModules = tmsModulesMergeLocalModuleCfg(targetModules, tmsConfig.appName);
@@ -66,13 +67,19 @@ async function task(tmsConfig, targetModules, isDev) {
     buildOutputAppJson,
     '开始生成编译后的app.json',
     '生成编译后的app.json完成',
-  )(tmsConfig, newModules, isDev);
+  )(tmsConfig, newModules);
+
+  await createTask(
+    symLink,
+    '开始创建软链接',
+    '创建软链接完成',
+  )(tmsConfig);
 
   return newModules;
 }
-async function init(tmsConfig, targetModules, isDev) {
+async function init(tmsConfig, targetModules) {
   try {
-    const newModules = await task(tmsConfig, targetModules, isDev);
+    const newModules = await task(tmsConfig, targetModules);
 
     return {
       targetModules: newModules,
@@ -80,6 +87,7 @@ async function init(tmsConfig, targetModules, isDev) {
   } catch (error) {
     const errMsg = typeof error === 'object' ? error.message : error;
     fail(`init流程出现错误${errMsg}`);
+    info('详细的错误信息', error);
     process.exit(1);
   }
 }

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

@@ -1,7 +1,8 @@
 const { createTask, resolve } = require('../../../utils/widgets');
-const { buildMpNpm } = require('../../../utils/mpCiUtils');
+const { buildMpNpm } = require('../../../core/mpCi');
 const { CACHE_DIR } = require('../../../config/constant');
-const { cloudNpmInstall, mpNpmInstallAll } = require('../../../utils/npmUtils');
+const { cloudNpmInstall, mpNpmInstallAll } = require('../../../core/npm');
+const { global } = require('../../../utils/global');
 
 async function install(tmsConfig, modules, isCloud = false) {
   // 小程序npm install
@@ -11,12 +12,13 @@ async function install(tmsConfig, modules, isCloud = false) {
     '小程序npm install 完成',
   )(modules, resolve(tmsConfig.outputDir), `${CACHE_DIR}/node_modules`);
 
-  // 构建miniprograme_npm
+  const tmsPrivateCf = global.getData('tmsPrivateCf');
+  // 构建miniprogram_npm
   await createTask(
     buildMpNpm,
-    '开始构建miniprograme_npm',
-    '构建miniprograme_npm 完成',
-  )({ appId: tmsConfig.appId, projectPath: resolve('./'), privateKey: tmsConfig.privateKey });
+    '开始构建miniprogram_npm',
+    '构建miniprogram_npm 完成',
+  )({ appId: tmsConfig.appId, projectPath: resolve('./'), privateKey: tmsPrivateCf.privateKey });
 
   // 安装云函数的
   isCloud && createTask(

package/src/utils/global.js

@@ -1,36 +1,22 @@
-class Globale {
-  constructor() {
-    this.moduleCache = {};
-  }
-
-  setModuleCache(url, branch, dest) {
-    const instance =  getGlobalInstance();
-
-    const key = `${branch}:${url}`;
-
-    instance.moduleCache[key] = {
-      dest,
-    };
-
-    return instance.moduleCache[key];
-  }
-
-  getModuleCache(url, branch) {
-    const instance = getGlobalInstance();
-
-    return instance.moduleCache[`${branch}:${url}`];
-  }
-}
-
-let instance;
-function getGlobalInstance() {
-  if (instance) {
-    return instance;
-  }
-
-  return instance = new Globale();
-}
+const global = {
+  data: {},
+  setData(...args) {
+    if (args.length === 1) {
+      Object.keys(args[0]).forEach((k) => {
+        if (args[0][k]) {
+          this.data[k] = args[0][k];
+        }
+      });
+    } else {
+      const [name, value] = args;
+      this.data[name] = value;
+    }
+  },
+  getData(name) {
+    return this.data[name];
+  },
+};
 
 module.exports = {
-  getGlobalInstance,
+  global,
 };

package/src/utils/io.js

@@ -1,5 +1,6 @@
 const fs = require('fs');
 const path = require('path');
+const { info } = require('../utils/log');
 /**
  * 判断目录是否为空
  * @param {string} dirname 目录名
@@ -43,11 +44,11 @@ function diffContentCopyFile(originFile, destFile) {
     const depDestContent = fs.readFileSync(destFile, 'utf8');
     const depOriginContent = fs.readFileSync(originFile, 'utf8');
     if (depDestContent !== depOriginContent) {
-      console.log(`拷贝${originFile}内容到${destFile}`);
+      info(`拷贝${originFile}内容到${destFile}`);
       copyFile(originFile, destFile);
     }
   } else {
-    console.log(`拷贝${originFile}内容到${destFile}`);
+    info(`拷贝${originFile}内容到${destFile}`);
     copyFile(originFile, destFile);
   }
 }

package/src/utils/log.js

@@ -37,8 +37,11 @@ const warn = (message) => {
   console.log(chalk.yellow(message));
 };
 
+const info = (...args) => console.log(...args);
+
 module.exports = {
   fail,
   succeed,
   warn,
+  info,
 };

package/src/utils/widgets.js

@@ -5,9 +5,9 @@ const ora = require('ora');
 const path = require('path');
 const fs = require('fs');
 const shelljs = require('shelljs');
-const download = require('download-git-repo');
+const { info } = require('./log');
 const chalk = require('chalk');
-const shelljsOptions =  { slient: true };
+const shelljsOptions =  { slient: true, async: false };
 
 // 获取当前目录
 const cwd = process.cwd();
@@ -15,11 +15,6 @@ function resolve(...args) {
   return path.resolve(cwd, ...args);
 };
 
-/**
- * 封装logs
- * @returns {Undefined} 无需返回值
- */
-const log = (...args) => console.log(...args);
 
 /**
  * 用户输入命令时，进行提示
@@ -38,7 +33,7 @@ const suggestCommands = (unknownCommand) => {
   });
 
   if (suggestion) {
-    log(`  ${chalk.red(`Did you mean ${chalk.yellow(suggestion)}?`)}`);
+    info(`  ${chalk.red(`Did you mean ${chalk.yellow(suggestion)}?`)}`);
   }
 };
 
@@ -60,58 +55,74 @@ function isArray(obj) {
   return Object.prototype.toString.call(obj) === '[object Array]';
 }
 
+
 /**
- * 下载模块到目标目录
+ * 下载模块代码
+ * @param { string } url 模块地址
  * @param { string } dest 目标地址
- * @param { object } downloadOptions 模块下载配置 { repoUrl-仓库地址, gitUrl-git地址, branch-分支或者tag }
+ * @param { string } branch 分支名
  * @returns { undefined } no return
  */
-function downloadRepo(dest, downloadOptions = { repoUrl: '', gitUrl: '', branch: '' }) {
-  const { repoUrl, gitUrl, branch } = downloadOptions;
+function downloadRepoForGit(url, dest, branch) {
+  const cwd = process.cwd();
+  return new Promise((resolve, reject) => {
+    // 如果目标目录不存在
+    if (fs.existsSync(dest)) {
+      shelljs.rm('-rf', path.join(dest));
+    }
 
-  if (fs.existsSync(dest)) {
-    shelljs.rm('-rf', dest);
-  }
+    shelljs.mkdir('-p', dest);
+    shelljs.cd(dest);
 
-  shelljs.mkdir('-p', dest);
-  return new Promise((resolve) => {
-    download(`${repoUrl}#${branch}`, dest, { clone: true }, async (e) => {
-      if (e) {
-        console.log(e) // eslint-disable-line
-        await downloadRepoForGit(gitUrl, dest, branch);
+    shelljs.exec(`git clone ${url} ${dest} --branch ${branch} --depth 1`,  { silent: true }, (code, stdout, stderr) => {
+      if (code !== 0) {
+        reject(stderr);
       }
-
+      shelljs.cd(cwd);
       resolve();
     });
   });
 }
 
+
 /**
- * 下载模块到目标目录备用方案
- * @param { string } url 模块地址
- * @param { string } dest 目标地址
+ * pull模块代码
+ * @param { string } dest 下载代码的路径
  * @param { string } branch 分支名
  * @returns { undefined } no return
  */
-function downloadRepoForGit(url, dest, branch) {
+function pullRepoForGit(dest, branch) {
   const cwd = process.cwd();
-
   return new Promise((resolve, reject) => {
-    // 如果目标目录不存在
-    if (fs.existsSync(dest)) {
-      shelljs.rm('-rf', path.join(dest));
-    }
-
-    shelljs.mkdir('-p', dest);
     shelljs.cd(dest);
+    shelljs.exec('git config pull.rebase false', shelljsOptions);
+    shelljs.exec(`git pull origin ${branch}`, { silent: true }, (code, stdout, stderr) => {
+      if (code !== 0) {
+        reject(stderr);
+      }
+      shelljs.cd(cwd);
+      resolve();
+    });
+  });
+}
 
-    const gitCloneRes = shelljs.exec(`git clone ${url} ${dest} --branch ${branch} --depth 1`, shelljsOptions);
-    if (gitCloneRes.code !== 0) {
-      reject(gitCloneRes.stderr);
-    }
-
-    shelljs.cd(cwd);
-    resolve();
+/**
+ * npm 下载依赖
+ * @param {*} dir
+ * @returns
+ */
+function npmInstall(dir) {
+  return new Promise((resolve, reject) => {
+    shelljs.exec(
+      'npx yarn --production --registry http://mirrors.tencent.com/npm/',
+      { cwd: dir, silent: true },
+      (code, stdout, stderr) => {
+        if (code !== 0) {
+          reject(stderr);
+        }
+        resolve();
+      },
+    );
   });
 }
 
@@ -136,7 +147,7 @@ function createTask(task, startText, endText) {
     const spinner = ora(startText);
 
     spinner.start();
-    console.log('\n');
+    info('\n');
 
     const result = await task(...args);
 
@@ -156,12 +167,12 @@ const camelize = str => str.replace(/-(\w)/g, (a, c) => (c ? c.toUpperCase() : '
 
 module.exports = {
   resolve,
-  log,
   isObject,
   isArray,
   createTask,
-  downloadRepo,
   downloadRepoForGit,
+  pullRepoForGit,
   suggestCommands,
   camelize,
+  npmInstall,
 };

package/src/utils/cliUtils.js

@@ -1,35 +0,0 @@
-const fs = require('fs');
-const cp = require('child_process');
-
-const getDevtoolCliPath = async () => {
-  let cliPath;
-  if (process.platform === 'darwin') {
-    cliPath = '/Applications/wechatwebdevtools.app/Contents/MacOS/cli';
-  } else if (process.platform === 'win32') {
-    cliPath = 'C:/Program Files (x86)/Tencent/微信web开发者工具/cli.bat';
-  } else {
-    // 其余平台暂不支持
-    throw new Error('unsupported platform');
-  }
-  const exists = await new Promise(resolve => fs.exists(cliPath, resolve));
-  if (!exists) {
-    // 找不到开发工具
-    throw new Error(`未找到微信小程序开发者工具，请确认是否安装，如未安装请前往 
-    https://developers.weixin.qq.com/miniprogram/dev/devtools/download.html 下载`);
-  }
-  return cliPath;
-};
-
-const openDevtool = async (path) => {
-  const cliPath = await getDevtoolCliPath();
-  const child = cp.spawn(cliPath, ['open', '--project', path], {
-    detached: true,
-    stdio: 'inherit',
-  });
-  child.unref();
-};
-
-module.exports = {
-  getDevtoolCliPath,
-  openDevtool,
-};