@tmsfe/tmskit 0.0.21 → 0.0.24

package/src/core/recommendVersion.js

@@ -0,0 +1,118 @@
+const fs = require('fs');
+const path = require('path');
+const shelljs = require('shelljs');
+const chalk = require('chalk');
+const request = require('request');
+const inquirer = require('inquirer');
+const { infoNoTime } = require('../utils/log');
+const packageJson = require('../../package.json');
+const { VERSION_CACHE_FILE, VERSION_URL } = require('../config/constant');
+const { ensureDirExist } = require('../utils/io');
+const { versionCompare } = require('../utils/widgets');
+
+// 获取推荐的tmskit版本
+function getRecommendVersion() {
+  return new Promise((resolve, reject) => {
+    request(`${VERSION_URL}?v=${new Date().getTime()}`, (error, response, body) => {
+      if (!error && response && response.statusCode === 200) {
+        resolve(JSON.parse(body));
+      } else {
+        reject(response.statusCode);
+      }
+    });
+  });
+}
+
+// 获取当前用户tmskit的版本
+function getUserTmskitVersion() {
+  const data = shelljs.exec('tmskit -v', { async: false, silent: true });
+  if (data.code === 0) {
+    // tmskit 0.0.21 => 0.0.21
+    return data.slice(7);
+  }
+  return '0.0.0';
+}
+
+// 询问用户是否安装最新版本
+function isInstallLatestVersion() {
+  return inquirer.prompt([
+    {
+      type: 'confirm',
+      name: 'isInstall',
+      message: '是否安装最新版本',
+      choices: [{
+        name: '否',
+        value: false,
+      }, {
+        name: '是',
+        value: true,
+      }],
+    },
+  ]);
+}
+
+// 获取tmskit的版本是否推荐过
+function getVersionIsRecommend(version) {
+  const filePath = VERSION_CACHE_FILE;
+  if (!fs.existsSync(filePath)) {
+    return false;
+  }
+  const content = require(filePath);
+  return content?.[version];
+}
+
+// 设置tmskit版本推荐过
+function setVersionRecommend(version, isRecommend) {
+  const filePath = VERSION_CACHE_FILE;
+  if (!fs.existsSync(filePath)) {
+    const dir = path.dirname(filePath);
+    ensureDirExist(dir);
+    fs.writeFileSync(filePath, '{}');
+  }
+  const content = require(filePath);
+  content[version] = isRecommend;
+  fs.writeFileSync(filePath, JSON.stringify(content, null, 2));
+}
+
+// 推荐理由
+function displayRecommends(arr = []) {
+  infoNoTime(chalk.green('构建工具有新的版本~~:'));
+  arr.forEach((item) => {
+    infoNoTime(chalk.green(item));
+  });
+}
+
+// 推荐tmskit的安装版本
+async function recommendVersion() {
+  try {
+    // 获取当前用户安装的版本
+    const tmskitVersion = getUserTmskitVersion();
+    // 获取官方推荐版本
+    const recommendRes = await getRecommendVersion();
+    const recommendVersion = recommendRes.version;
+    // 当前用户安装版本小于官方推荐版本 && 该版本没有推荐过
+    if (versionCompare(tmskitVersion, recommendVersion) === -1 && !getVersionIsRecommend(recommendVersion)) {
+      displayRecommends(recommendRes.version_detail);
+      // 设置该版本推荐过
+      setVersionRecommend(recommendVersion, true);
+      // 询问用户是否安装最新版本
+      const installRes = await isInstallLatestVersion(recommendRes);
+      if (installRes.isInstall) {
+        // mac
+        if (process.platform === 'darwin') {
+          infoNoTime(`将执行以下命令: ${chalk.green(`sudo npm install -g ${packageJson.name}@${recommendVersion}`)}`);
+          shelljs.exec(`sudo npm install -g ${packageJson.name}@${recommendVersion}`, { async: false, silent: false });
+          process.exit(-1);
+        } else {
+          // window
+          infoNoTime(`请使用超级管理员执行以下命令: ${chalk.green(`npm install -g ${packageJson.name}@${recommendVersion}`)}`);
+          process.exit(-1);
+        }
+      }
+    }
+  } catch {}
+}
+
+module.exports = {
+  recommendVersion,
+};

package/src/core/report.js

@@ -0,0 +1,30 @@
+const request = require('request');
+const shelljs = require('shelljs');
+const apiUrl = 'https://tim.map.qq.com/basic/tmskit/upload';
+
+function getGitUser() {
+  const res = shelljs.exec('git config user.name', { async: false, silent: true });
+  return res.stdout;
+}
+
+const report = (name, attrs = {}) => {
+  try {
+    const param = [];
+    param[27] = name;
+    param[28] = 'tmskit';
+    param[29] = getGitUser();
+    param[30] = JSON.stringify(attrs);
+
+    for (let i = 0; i < 40; i++) {
+      if (!param[i]) param[i] = null;
+    };
+
+    request.post({ url: apiUrl, json: { param } });
+    // (error, response, body) => {
+    //   console.log('body:', body);
+    // }
+  } catch (e) {
+  }
+};
+
+module.exports = report;

package/src/core/tmsMpconfig.js

@@ -12,28 +12,29 @@ const { fail } = require('../utils/log');
 
 /**
  * 读取tms.config.js
- * @param env {string} 环境变量
+ *  @param {string} configPath tms.config.js的路径
  */
-const readTmsConfig = function () {
-  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 = 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)) {
     const tmsPrivateFn = require(tmsPrivatePath);
     tmsPrivateCf = typeof tmsPrivateFn === 'function' ? tmsPrivateFn() : tmsPrivateFn;
@@ -44,11 +45,12 @@ const readTmsPrivateCf = function () {
 
 /**
  * 获取tms.config.js， tms.private.config.js的配置项
+ *  @param {string} configPath config.js的路径
  * @returns
  */
-const getTmsConfig = () => {
-  const tmsPrivateCf = readTmsPrivateCf();
-  const tmsConfig = readTmsConfig();
+const getTmsConfig = (configPath) => {
+  const tmsPrivateCf = readTmsPrivateCf(configPath);
+  const tmsConfig = readTmsConfig(configPath);
 
   const modules = {};
   if (Array.isArray(tmsConfig.modules)) {

package/src/entry.js

@@ -6,9 +6,20 @@ module.exports = [
       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,71 +1,98 @@
+/* eslint-disable no-param-reassign */
 const chalk = require('chalk');
 const commander = require('commander');
-const { suggestCommands, resolve } = 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 check = require('./check');
-const fs = require('fs');
+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);
     }
   });
 }
 
-function register() {
+// 注册扩展命令
+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);
 
-  // 注册扩展命令
-  if (fs.existsSync(resolve('tms.config.js'))) {
-    const tmsConfig = getTmsConfig();
-    if (Array.isArray(tmsConfig?.commands)) {
-      registerCommand(program, tmsConfig.commands);
-    }
+  // 注册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));
   }
 }
-register();
-
-program.on('--help', () => {
-  info(`  Run ${chalk.cyan(`${TMS_NAME}  <command> --help`)} for detailed usage of given command.`);
-});
+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/index.js

@@ -15,6 +15,7 @@ const { fail, succeed, info } = require('../../utils/log');
 const generator = require('./generator');
 const request = require('request');
 const unzip = require('unzipper');
+const report = require('../../core/report');
 
 /**
  * 如果该目录下面存在文件，换个名字
@@ -71,6 +72,7 @@ async function create(projectName) {
   const cwd = process.cwd();
   const targetDir = path.resolve(cwd, projectName);
   const { projectType } = await inquirer.prompt(CREATE_TEMPLATE_QUESTION);
+  report('create-start', { projectType });
 
   // 创建项目目录
   await createProjectDir(targetDir);
@@ -101,7 +103,7 @@ async function create(projectName) {
       }
       shelljs.rm('-rf', resolve(projectName, 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,6 +2,7 @@ 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) {
   // 开始构建前，清理输出目录
@@ -10,11 +11,12 @@ async function build(tmsConfig, targetModules) {
   const { modules: newModules } = await init(tmsConfig, targetModules);
 
   const isDev = false;
-  if (typeof tmsConfig?.hooks?.beforeCompile === 'function') {
-    await tmsConfig?.hooks?.beforeCompile({
+  if (typeof tmsConfig?.hooks?.beforeFirstCompile === 'function') {
+    await tmsConfig?.hooks?.beforeFirstCompile({
       isDev,
       tmsConfig: filterField(tmsConfig, ['gitAccount']),
       modules: newModules });
+    report('hooks:beforeCompile');
   };
   compileBuild(tmsConfig, newModules, isDev);
 }

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

@@ -5,7 +5,9 @@ const init = require('../init/index');
 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)
@@ -29,19 +31,23 @@ 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 { subPackages, modules: newModules } = await init(tmsConfig, targetModules);
 
   info('当前dev启动的有效模块', newModules.map(item => item.moduleName).sort());
-  if (typeof tmsConfig?.hooks?.beforeCompile === 'function') {
-    await tmsConfig?.hooks?.beforeCompile({
+  if (typeof tmsConfig?.hooks?.beforeFirstCompile === 'function') {
+    await tmsConfig?.hooks?.beforeFirstCompile({
       isDev: true,
       tmsConfig: filterField(tmsConfig, ['gitAccount']),
       modules: newModules,
     });
+    report('hooks:beforeCompile');
   };
   delOtherPackages(tmsConfig, subPackages);
   compileDev(tmsConfig, newModules, true);

package/src/scripts/run/index.js

@@ -6,6 +6,7 @@ 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 {
   getTmsConfig,
   getModulesByMergeDepModules,
@@ -45,10 +46,9 @@ const getSpecificModuleNames = (moduleArg, modules) => {
 };
 
 async function run(commandName, cmd) {
+  // 用户本地的配置
+  const tmsConfig = getTmsConfig();
   try {
-    // 用户本地的配置
-    const tmsConfig = getTmsConfig();
-
     // 缓存数据
     global.setData({
       cmd,
@@ -57,11 +57,13 @@ async function run(commandName, cmd) {
 
     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);
@@ -87,17 +89,21 @@ function otherCommands(tmsConfig, commandName, cmd) {
   switch (commandName) {
     case 'init':
       init(tmsConfig, newModules);
+      report('run:init', { appName: tmsConfig?.appName });
       return;
     case 'dev':
       global.setData('isDev', true);
       dev(tmsConfig, newModules);
+      report('run:dev', { appName: tmsConfig?.appName });
       return;
     case 'install':
       install(tmsConfig, subPackages, false);
+      report('run:install', { appName: tmsConfig?.appName });
       return;
     case 'build':
       global.setData('isDev', false);
       build(tmsConfig, newModules);
+      report('run:build', { appName: tmsConfig?.appName });
       return;
     default:
       return;

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

@@ -0,0 +1,36 @@
+const fs = require('fs');
+const path = require('path');
+const { NPM_CACHE_FILE } = require('../../../config/constant');
+const { ensureDirExist } = require('../../../utils/io');
+
+function getCache(projectDir, type) {
+  const filePath = NPM_CACHE_FILE;
+  if (!fs.existsSync(filePath)) {
+    return null;
+  }
+  const content = require(filePath);
+  return content?.[projectDir]?.[type];
+}
+
+
+function setCache(projectDir, type = 'miniprogram_npm', data) {
+  const filePath = NPM_CACHE_FILE;
+  if (!fs.existsSync(filePath)) {
+    const dir = path.dirname(filePath);
+    ensureDirExist(dir);
+    fs.writeFileSync(filePath, '{}');
+  }
+  const content = require(filePath);
+  if (!content[projectDir]) {
+    content[projectDir] = {};
+  }
+  content[projectDir] = {
+    [type]: data,
+  };
+  fs.writeFileSync(filePath, JSON.stringify(content, null, 2));
+}
+
+module.exports = {
+  setCache,
+  getCache,
+};

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

@@ -4,8 +4,8 @@ const path = require('path');
 const io = require('../../../utils/io');
 const { createTask, resolve, getAbsolutePath } = require('../../../utils/widgets');
 const { buildMpNpm } = require('../../../core/mpCi');
-const { setCache, getCache } = require('../../../core/cache');
-const { CACHE_DIR } = require('../../../config/constant');
+const { setCache, getCache } = require('./cache');
+const { NODE_MODULES_DIR } = require('../../../config/constant');
 const { npmInstallAll } = require('../../../core/npm');
 const { info } = require('../../../utils/log');
 const { fileMd5 } = require('../../../utils/md5');
@@ -52,7 +52,7 @@ async function npmInstall(tmsConfig, subPackages, useCache) {
     if (fs.existsSync(modulePackagePath)) shelljs.cp('-Rf', modulePackagePath, outputModuleDir);
   });
 
-  await npmInstallAll(subPackages, resolve(tmsConfig.outputDir), `${CACHE_DIR}/node_modules`);
+  await npmInstallAll(subPackages, resolve(tmsConfig.outputDir), NODE_MODULES_DIR);
   return { isCache: false };
 }
 

package/src/utils/log.js

@@ -40,9 +40,12 @@ const warn = (message) => {
 
 const info = (...args) => console.log(`${moment().format('YYYY-MM-DD HH:mm:ss')}`, ...args);
 
+const infoNoTime = (...args) => console.log(...args);
+
 module.exports = {
   fail,
   succeed,
   warn,
   info,
+  infoNoTime,
 };