@tmsfe/tmskit 0.0.6 → 0.0.7

package/src/utils/log.js

@@ -1,44 +1,44 @@
-const chalk = require('chalk');
-
-/**
- * 本文件提供无依赖的在终端打印彩色文字的方法。
- */
-const resetCfg = decodeURIComponent('%1B%5B0m'); // \033[0m转义后的字符按,用来还原属性
-
-/**
- * 打印红底黑字格式的文字
- * @param {String} message 需要打印的文字信息
- * @returns {undefined} 无
- */
-const fail = (message = '') => {
-  const redStyleConfig = decodeURIComponent('%1B%5B41%3B30m'); // \033[41;30m转义后的字符按，console时输出红色文字
-  const greenFontStyleConfig = decodeURIComponent('%1B%5B41%3B37m'); // \033[41;30m转义后的字符按，console时输出红底白色文字
-  console.log(`${redStyleConfig} ERROR ${greenFontStyleConfig} ${message}${resetCfg}`); // eslint-disable-line no-console
-};
-
-/**
- * 打印绿底黑字格式的文字
- * @param {String} message 需要打印的文字信息
- * @returns {undefined} 无
- */
-const succeed = (message = '') => {
-  const greenStyleConfig = decodeURIComponent('%1B%5B42%3B30m'); // \033[42;30m转义后的字符按，console时输出绿色文字
-  const greenFontStyleConfig = decodeURIComponent('%1B%5B40%3B32m'); // \033[40;32m转义后的字符按，console时输出绿色文字
-  console.log(`${greenStyleConfig} Success ${greenFontStyleConfig} ${message}${resetCfg}`); // eslint-disable-line no-console
-};
-
-
-/**
- * 打印warn提示
- * @param {String} message 需要打印的文字信息
- * @returns {undefined} 无
- */
-const warn = (message) => {
-  console.log(chalk.yellow(message));
-};
-
-module.exports = {
-  fail,
-  succeed,
-  warn,
-};
+const chalk = require('chalk');
+
+/**
+ * 本文件提供无依赖的在终端打印彩色文字的方法。
+ */
+const resetCfg = decodeURIComponent('%1B%5B0m'); // \033[0m转义后的字符按,用来还原属性
+
+/**
+ * 打印红底黑字格式的文字
+ * @param {String} message 需要打印的文字信息
+ * @returns {undefined} 无
+ */
+const fail = (message = '') => {
+  const redStyleConfig = decodeURIComponent('%1B%5B41%3B30m'); // \033[41;30m转义后的字符按，console时输出红色文字
+  const greenFontStyleConfig = decodeURIComponent('%1B%5B41%3B37m'); // \033[41;30m转义后的字符按，console时输出红底白色文字
+  console.log(`${redStyleConfig} ERROR ${greenFontStyleConfig} ${message}${resetCfg}`); // eslint-disable-line no-console
+};
+
+/**
+ * 打印绿底黑字格式的文字
+ * @param {String} message 需要打印的文字信息
+ * @returns {undefined} 无
+ */
+const succeed = (message = '') => {
+  const greenStyleConfig = decodeURIComponent('%1B%5B42%3B30m'); // \033[42;30m转义后的字符按，console时输出绿色文字
+  const greenFontStyleConfig = decodeURIComponent('%1B%5B40%3B32m'); // \033[40;32m转义后的字符按，console时输出绿色文字
+  console.log(`${greenStyleConfig} Success ${greenFontStyleConfig} ${message}${resetCfg}`); // eslint-disable-line no-console
+};
+
+
+/**
+ * 打印warn提示
+ * @param {String} message 需要打印的文字信息
+ * @returns {undefined} 无
+ */
+const warn = (message) => {
+  console.log(chalk.yellow(message));
+};
+
+module.exports = {
+  fail,
+  succeed,
+  warn,
+};

package/src/utils/mpCiUtils.js

@@ -1,73 +1,73 @@
-const ci = require('miniprogram-ci');
-const path = require('path');
-
-/**
- * 获取小程序ci的Project对象
- * @returns {Object} 小程序ci对象
- */
-const getMpCi = ({ appId, projectPath, type = 'miniProgram', privateKey = 'TODO' }) => {
-  const cfgJsonContent = require(path.join(projectPath, 'project.config.json'));
-  const ignores = cfgJsonContent?.packOptions?.ignore.map(({ value }) => value) || [];
-
-  return new ci.Project({
-    appid: appId,
-    privateKey,
-    type,
-    projectPath,
-    ignores: ['node_modules/**/*', ...ignores],
-  });
-};
-
-
-// 用小程序ci工具构建小程序
-const packMpProject = async (project) => {
-  await ci.packNpm(project, {
-    ignores: ['cloud/**/*'],
-  });
-};
-
-/**
- * 格式化构建npm结果信息
- * @param {Array<String>} warning 构建时的告警信息
- * @returns {String} npm构建错误信息
- */
-const formatPackNpmWarning = (warning) => {
-  if (!warning) {
-    return '';
-  }
-
-  const result = warning.map((it, index) => `${index + 1}. ${it.msg}
-  \t@ ${it.jsPath}:${it.tips}`).join('---------------\n');
-
-  return result;
-};
-
-/**
- * 构建miniprogram_npm
- *  @returns {Object} 小程序ci对象
- */
-const buildMpNpm = async ({
-  appId,
-  projectPath,
-  privateKey,
-}) => {
-  const mpCi = await getMpCi({
-    appId,
-    projectPath,
-    privateKey,
-  });
-
-  const packNpmWarning = await packMpProject(mpCi);
-
-  const packNpmMsg = formatPackNpmWarning(packNpmWarning);
-  if (packNpmMsg) {
-    return Promise.reject(packNpmMsg);
-  }
-
-  return Promise.resolve();
-};
-
-
-module.exports = {
-  buildMpNpm,
-};
+const ci = require('miniprogram-ci');
+const path = require('path');
+
+/**
+ * 获取小程序ci的Project对象
+ * @returns {Object} 小程序ci对象
+ */
+const getMpCi = ({ appId, projectPath, type = 'miniProgram', privateKey = 'TODO' }) => {
+  const cfgJsonContent = require(path.join(projectPath, 'project.config.json'));
+  const ignores = cfgJsonContent?.packOptions?.ignore.map(({ value }) => value) || [];
+
+  return new ci.Project({
+    appid: appId,
+    privateKey,
+    type,
+    projectPath,
+    ignores: ['node_modules/**/*', ...ignores],
+  });
+};
+
+
+// 用小程序ci工具构建小程序
+const packMpProject = async (project) => {
+  await ci.packNpm(project, {
+    ignores: ['cloud/**/*'],
+  });
+};
+
+/**
+ * 格式化构建npm结果信息
+ * @param {Array<String>} warning 构建时的告警信息
+ * @returns {String} npm构建错误信息
+ */
+const formatPackNpmWarning = (warning) => {
+  if (!warning) {
+    return '';
+  }
+
+  const result = warning.map((it, index) => `${index + 1}. ${it.msg}
+  \t@ ${it.jsPath}:${it.tips}`).join('---------------\n');
+
+  return result;
+};
+
+/**
+ * 构建miniprogram_npm
+ *  @returns {Object} 小程序ci对象
+ */
+const buildMpNpm = async ({
+  appId,
+  projectPath,
+  privateKey,
+}) => {
+  const mpCi = await getMpCi({
+    appId,
+    projectPath,
+    privateKey,
+  });
+
+  const packNpmWarning = await packMpProject(mpCi);
+
+  const packNpmMsg = formatPackNpmWarning(packNpmWarning);
+  if (packNpmMsg) {
+    return Promise.reject(packNpmMsg);
+  }
+
+  return Promise.resolve();
+};
+
+
+module.exports = {
+  buildMpNpm,
+};

package/src/utils/npmUtils.js

@@ -1,166 +1,166 @@
-/**
- * 本文件主要负责项目或者分包依赖的npm的安装
- */
-const fs = require('fs');
-const fsExtra = require('fs-extra');
-const crypto = require('crypto');
-const path = require('path');
-const shell = require('shelljs');
-const glob = require('glob-ignore');
-const LOG = require('./log');
-
-const shellJsOption = { async: false, silent: true };
-const dirPath = process.cwd(); // 项目根目录
-
-const install = async (packageJsonPath = '', retry = true, cacheDir) => {
-  const obj = {};
-  const packageContent = fs.readFileSync(packageJsonPath);
-  const packageJson = JSON.parse(packageContent);
-  obj.dependencies = packageJson.dependencies || {};
-  // obj.devDependencies = packageJson.devDependencies || {};
-
-  // dependencies和devDependencies字段为空,没有需要安装的npm包,直接return
-  // if (Object.keys(obj.dependencies).length === 0 && Object.keys(obj.devDependencies).length === 0) {
-  if (Object.keys(obj.dependencies).length === 0) {
-    return;
-  }
-
-  // 以package.json中dependencies字段stringify后的md5值作为缓存key
-  // 任意包名或者版本号的差异,将导致md5后的差异,从而导致缓存失效,重新下载
-  // 如此来保证npm缓存的准确性
-  const str = JSON.stringify(obj);
-  const key = crypto.createHash('md5').update(str)
-    .digest('hex');
-  const keyPath = path.join(cacheDir, key);
-  const tarFile = path.join(keyPath, 'node_modules.tar.gz');
-
-  // npm缓存路径不存在
-  // 或者缓存的包大小小于512byte,认为缓存不合法
-  // 清空缓存目录,重新下载npm包缓存
-  const missCache =  !fsExtra.pathExistsSync(keyPath)
-    || !fsExtra.existsSync(tarFile)
-    || fsExtra.statSync(tarFile).size < 512;
-  if (missCache) {
-    console.log(`未命中缓存，下载${packageJsonPath}依赖`);
-    fsExtra.emptydirSync(keyPath);
-    shell.cp('-f', packageJsonPath, keyPath);
-    shell.cd(keyPath);
-    try {
-      shell.exec('npx yarn --production --registry http://mirrors.tencent.com/npm/', shellJsOption);
-    } catch (err) {
-      console.log('err', err);
-      if (retry) {
-        return await install(packageJsonPath, false);
-      }
-      throw err;
-    }
-    shell.exec('tar -zcvf ./node_modules.tar.gz ./node_modules', shellJsOption);
-    shell.exec('rm -rf ./node_modules',  shellJsOption);
-  }
-  shell.cp('-Rf', tarFile, `${path.dirname(packageJsonPath)}/`);
-  shell.cd(path.dirname(packageJsonPath));
-
-  shell.exec('tar -xzvf ./node_modules.tar.gz -C ./',  shellJsOption);
-  shell.exec('rm -rf ./node_modules.tar.gz', shellJsOption);
-  return { missCache, key };
-};
-
-
-// 遍历安装指定目录下所有项目的npm依赖
-const mpNpmInstallAll = async (modules, contextDir, cacheDir) => {
-  const packageJsonFiles = await findAllPackageJson(modules, contextDir);
-  await Promise.all(packageJsonFiles.map(file => install(file, true, cacheDir)));
-};
-
-/**
- * 递归查找指定条件的文件
- * @param {String} startPath 开始查找的根路径
- * @param {String} filter 匹配的字符串
- * @returns {Array<String>} 查找到的文件路径列表
- */
-const findFilesByFilter = (startPath, filter) => {
-  const result = [];
-  /**
-   * 根据指定的筛选器查找文件
-   * @param {String} startPath 开始查找的文件夹路径
-   * @param {String} filter 筛选器
-   * @returns {Undefined} 无需返回值
-   */
-  const find = (startPath, filter) => {
-    // 目录不存在
-    if (!fs.existsSync(startPath)) {
-      LOG.fail(`${startPath}目录不存在`);
-      process.exit(-1);
-      return;
-    }
-
-    // 当前目录下的所有文件 / 文件夹
-    const exceptDir = ['node_modules', 'miniprogram_npm'];
-    if (exceptDir.find(item => startPath.indexOf(item) > -1)) {
-      return;
-    }
-    const files = fs.readdirSync(startPath);
-    files.forEach((file) => {
-      const filename = path.join(startPath, file);
-      const stat = fs.lstatSync(filename);
-      // 当前文件是文件夹类型，继续递归
-      if (stat.isDirectory()) {
-        find(filename, filter);
-      } else if (filename.indexOf(filter) >= 0) {
-        // 文件类型
-        result.push(filename);
-      };
-    });
-  };
-
-  find(startPath, filter);
-  return result;
-};
-
-/**
- * 找到项目中所有的package.json文件
- * @param {Array<String>} subRoots 需要安装npm依赖的路径
- * @param {String} contextDir 命令运行的目录
- * @returns {Array<String>} 找到的所有package.json文件的路径
- */
-const findAllPackageJson = (subRoots = [], contextDir) => {
-  const packageJsonName = 'package.json';         // 查找文件名
-  const cwd = contextDir || dirPath;
-  const result = [path.join(cwd, packageJsonName)]; // 默认填充根目录下的package.json
-
-  subRoots.forEach((subRoot) => {
-    if (!subRoot.root) {
-      LOG.fail(`请检查${subRoot.name}的module.config.json是否有root字段`);
-      process.exit(1);
-    }
-    const toppath = path.join(cwd, subRoot.root); // 从该目录开始查找package.json文件
-    const list = findFilesByFilter(toppath, packageJsonName);
-
-    result.push(...list);
-  });
-
-  return result;
-};
-
-function cloudNpmInstall(contextDir) {
-  return new Promise((resolve, reject) => {
-    glob(`${contextDir}/**/package.json`, ['node_modules', 'miniprogram_npm'], (err, files) => {
-      if (err) {
-        reject(err);
-      }
-      files.forEach((file) => {
-        const dir = path.dirname(file);
-        shell.cd(dir);
-        shell.exec('npx npm install --production --registry http://mirrors.tencent.com/npm/', { silent: false });
-      });
-      resolve();
-    });
-  });
-}
-
-
-module.exports = {
-  cloudNpmInstall,
-  mpNpmInstallAll,
-  findAllPackageJson,
-};
+/**
+ * 本文件主要负责项目或者分包依赖的npm的安装
+ */
+const fs = require('fs');
+const fsExtra = require('fs-extra');
+const crypto = require('crypto');
+const path = require('path');
+const shell = require('shelljs');
+const glob = require('glob-ignore');
+const LOG = require('./log');
+
+const shellJsOption = { async: false, silent: true };
+const dirPath = process.cwd(); // 项目根目录
+
+const install = async (packageJsonPath = '', retry = true, cacheDir) => {
+  const obj = {};
+  const packageContent = fs.readFileSync(packageJsonPath);
+  const packageJson = JSON.parse(packageContent);
+  obj.dependencies = packageJson.dependencies || {};
+  // obj.devDependencies = packageJson.devDependencies || {};
+
+  // dependencies和devDependencies字段为空,没有需要安装的npm包,直接return
+  // if (Object.keys(obj.dependencies).length === 0 && Object.keys(obj.devDependencies).length === 0) {
+  if (Object.keys(obj.dependencies).length === 0) {
+    return;
+  }
+
+  // 以package.json中dependencies字段stringify后的md5值作为缓存key
+  // 任意包名或者版本号的差异,将导致md5后的差异,从而导致缓存失效,重新下载
+  // 如此来保证npm缓存的准确性
+  const str = JSON.stringify(obj);
+  const key = crypto.createHash('md5').update(str)
+    .digest('hex');
+  const keyPath = path.join(cacheDir, key);
+  const tarFile = path.join(keyPath, 'node_modules.tar.gz');
+
+  // npm缓存路径不存在
+  // 或者缓存的包大小小于512byte,认为缓存不合法
+  // 清空缓存目录,重新下载npm包缓存
+  const missCache =  !fsExtra.pathExistsSync(keyPath)
+    || !fsExtra.existsSync(tarFile)
+    || fsExtra.statSync(tarFile).size < 512;
+  if (missCache) {
+    console.log(`未命中缓存，下载${packageJsonPath}依赖`);
+    fsExtra.emptydirSync(keyPath);
+    shell.cp('-f', packageJsonPath, keyPath);
+    shell.cd(keyPath);
+    try {
+      shell.exec('npx yarn --production --registry http://mirrors.tencent.com/npm/', shellJsOption);
+    } catch (err) {
+      console.log('err', err);
+      if (retry) {
+        return await install(packageJsonPath, false);
+      }
+      throw err;
+    }
+    shell.exec('tar -zcvf ./node_modules.tar.gz ./node_modules', shellJsOption);
+    shell.exec('rm -rf ./node_modules',  shellJsOption);
+  }
+  shell.cp('-Rf', tarFile, `${path.dirname(packageJsonPath)}/`);
+  shell.cd(path.dirname(packageJsonPath));
+
+  shell.exec('tar -xzvf ./node_modules.tar.gz -C ./',  shellJsOption);
+  shell.exec('rm -rf ./node_modules.tar.gz', shellJsOption);
+  return { missCache, key };
+};
+
+
+// 遍历安装指定目录下所有项目的npm依赖
+const mpNpmInstallAll = async (modules, contextDir, cacheDir) => {
+  const packageJsonFiles = await findAllPackageJson(modules, contextDir);
+  await Promise.all(packageJsonFiles.map(file => install(file, true, cacheDir)));
+};
+
+/**
+ * 递归查找指定条件的文件
+ * @param {String} startPath 开始查找的根路径
+ * @param {String} filter 匹配的字符串
+ * @returns {Array<String>} 查找到的文件路径列表
+ */
+const findFilesByFilter = (startPath, filter) => {
+  const result = [];
+  /**
+   * 根据指定的筛选器查找文件
+   * @param {String} startPath 开始查找的文件夹路径
+   * @param {String} filter 筛选器
+   * @returns {Undefined} 无需返回值
+   */
+  const find = (startPath, filter) => {
+    // 目录不存在
+    if (!fs.existsSync(startPath)) {
+      LOG.fail(`${startPath}目录不存在`);
+      process.exit(-1);
+      return;
+    }
+
+    // 当前目录下的所有文件 / 文件夹
+    const exceptDir = ['node_modules', 'miniprogram_npm'];
+    if (exceptDir.find(item => startPath.indexOf(item) > -1)) {
+      return;
+    }
+    const files = fs.readdirSync(startPath);
+    files.forEach((file) => {
+      const filename = path.join(startPath, file);
+      const stat = fs.lstatSync(filename);
+      // 当前文件是文件夹类型，继续递归
+      if (stat.isDirectory()) {
+        find(filename, filter);
+      } else if (filename.indexOf(filter) >= 0) {
+        // 文件类型
+        result.push(filename);
+      };
+    });
+  };
+
+  find(startPath, filter);
+  return result;
+};
+
+/**
+ * 找到项目中所有的package.json文件
+ * @param {Array<String>} subRoots 需要安装npm依赖的路径
+ * @param {String} contextDir 命令运行的目录
+ * @returns {Array<String>} 找到的所有package.json文件的路径
+ */
+const findAllPackageJson = (subRoots = [], contextDir) => {
+  const packageJsonName = 'package.json';         // 查找文件名
+  const cwd = contextDir || dirPath;
+  const result = [path.join(cwd, packageJsonName)]; // 默认填充根目录下的package.json
+
+  subRoots.forEach((subRoot) => {
+    if (!subRoot.root) {
+      LOG.fail(`请检查${subRoot.name}的module.config.json是否有root字段`);
+      process.exit(1);
+    }
+    const toppath = path.join(cwd, subRoot.root); // 从该目录开始查找package.json文件
+    const list = findFilesByFilter(toppath, packageJsonName);
+
+    result.push(...list);
+  });
+
+  return result;
+};
+
+function cloudNpmInstall(contextDir) {
+  return new Promise((resolve, reject) => {
+    glob(`${contextDir}/**/package.json`, ['node_modules', 'miniprogram_npm'], (err, files) => {
+      if (err) {
+        reject(err);
+      }
+      files.forEach((file) => {
+        const dir = path.dirname(file);
+        shell.cd(dir);
+        shell.exec('npx npm install --production --registry http://mirrors.tencent.com/npm/', { silent: false });
+      });
+      resolve();
+    });
+  });
+}
+
+
+module.exports = {
+  cloudNpmInstall,
+  mpNpmInstallAll,
+  findAllPackageJson,
+};