@tmsfe/tmskit 0.0.5-beta.5 → 0.0.7

package/src/utils/cloneModules.js

@@ -1,91 +1,116 @@
-const MetalSmith = require('metalsmith');
-const { getGlobalInstance } = require('./global.js');
-const { downloadRepoForGit, resolve } = require('./widgets');
-const { fail } = require('./log');
-const fs = require('fs');
-const shelljs = require('shelljs');
-
-/**
- * 对克隆下来的模块进行相应的文件处理操作，比如收集处理模块信息，进行信息缓存等操作
- * @param { string } sourceDir 缓存文件夹
- * @param { string } targetDir 目标文件夹
- * @param { arrary } ignore
- * @returns { undefined } no return
- */
-function moveFile(sourceDir, targetDir, ignore = []) {
-  // 删除不是文件夹的文件
-  return new Promise((resolve) => {
-    MetalSmith(__dirname)
-      .ignore(ignore)
-      .source(sourceDir)
-      .destination(targetDir)
-      .build((e) => {
-        if (e) {
-          fail(e); // eslint-disable-line
-          console.log('MetalSmith 详细的错误信息:', e);
-        }
-        resolve();
-      });
-  });
-}
-
-/**
- * 下载目标模块
- * @param { string } sourceDir 缓存文件夹
- * @param { string } targetDir 目标文件夹
- * @returns { array } modules 描述模块的列表
- */
-async function cloneModules(sourceDir, targetDir, modules) {
-  // 根据小程序的配置文件下载模块， 并且处理信息
-  for (const moduleInfo of modules) { // eslint-disable-line
-    if (moduleInfo.repoInfo) {
-      await downLoadAndMoveModule(sourceDir, targetDir, moduleInfo);
-    }
-  }
-}
-
-/**
- * 下载模块信息并且将它移动到对应的位置
- * @param { string } sourceDir 代码缓存文件夹
- * @param { string } targetDir 代码要放到的目标文件夹
- * @returns { array } moduleInfo 描述模块的信息
- */
-async function downLoadAndMoveModule(sourceDir, targetDir,  moduleInfo) {
-  const { repoInfo: { buildGitTag, httpRepoUrl }, path } = moduleInfo;
-
-  // 源码临时存在的源目录
-  let sourcePath = resolve(sourceDir, path);
-  // 源码要放到目标目录
-  const targetPath = resolve(targetDir, path);
-  // 设置模块的构建分支
-  const cloneBranch =  buildGitTag && typeof buildGitTag === 'string' ? buildGitTag : 'master';
-
-  // 检查缓存中有没有
-  const globalInstance = getGlobalInstance();
-  const moduleInCache = globalInstance.getModuleCache(httpRepoUrl, cloneBranch);
-
-
-  try {
-    if (!moduleInCache) {
-      await downloadRepoForGit(httpRepoUrl, sourcePath, cloneBranch);
-      globalInstance.setModuleCache(httpRepoUrl, cloneBranch, sourcePath);
-    } else {
-      sourcePath = globalInstance.getModuleCache(httpRepoUrl, cloneBranch).dest;
-    }
-
-    if (fs.existsSync(targetPath)) {
-      shelljs.rm('-rf', targetPath);
-    }
-    await moveFile(sourcePath, targetPath, [
-      'node_modules',
-      '.git',
-    ]);
-  } catch (e) {
-    fail(`downLoadAndMoveModule ${e}`);  // eslint-disable-line
-    process.exit(-1);
-  }
-}
-
-module.exports = {
-  cloneModules,
-};
+const MetalSmith = require('metalsmith');
+const { getGlobalInstance } = require('./global.js');
+const { downloadRepoForGit, resolve } = require('./widgets');
+const { readTmsPrivateCf } = require('../utils/tkitUtils');
+const { fail } = require('./log');
+const fs = require('fs');
+const shelljs = require('shelljs');
+const { handleError } = require('./handleError.js');
+
+/**
+ * 处理用户没有clone git仓库权限问题——拼接账号信息
+ * @param {*} httpRepoUrl
+ * @param {*} moduleName
+ * @returns
+ */
+function replaceGitUrlAccount(httpRepoUrl, moduleName, privateCf) {
+  let gitUrl = httpRepoUrl;
+  const { username = '', pass = '' } = privateCf?.gitAccout?.[moduleName] || {};
+
+  const urlPrefixReg = /http(s)?:\/\//;
+  if (username && pass && urlPrefixReg.test(gitUrl)) {
+    gitUrl = gitUrl.replace(urlPrefixReg, val => `${val}${encodeURIComponent(username)}:${pass}@`);
+  }
+
+  return gitUrl;
+}
+
+/**
+ * 对克隆下来的模块进行相应的文件处理操作，比如收集处理模块信息，进行信息缓存等操作
+ * @param { string } sourceDir 缓存文件夹
+ * @param { string } targetDir 目标文件夹
+ * @param { arrary } ignore
+ * @returns { undefined } no return
+ */
+function moveFile(sourceDir, targetDir, ignore = []) {
+  // 删除不是文件夹的文件
+  return new Promise((resolve, reject) => {
+    MetalSmith(__dirname)
+      .ignore(ignore)
+      .source(sourceDir)
+      .destination(targetDir)
+      .build((e) => {
+        if (e) {
+          fail(`${sourceDir} moveFile ${targetDir}出现错误: ${e}`);
+          reject(e);
+        }
+        resolve();
+      });
+  });
+}
+
+/**
+ * 下载目标模块
+ * @param { string } sourceDir 缓存文件夹
+ * @param { string } targetDir 目标文件夹
+ * @param { boolean } isDev 是否是dev
+ * @returns { array } modules 描述模块的列表
+ */
+async function cloneModules(sourceDir, targetDir, modules, isDev) {
+  // 用户本地的私有项目配置（用来配置环境\模块信息\账号信息）
+  const privateCf = readTmsPrivateCf();
+
+  // 根据小程序的配置文件下载模块， 并且处理信息
+  for (const moduleInfo of modules) {
+    if (moduleInfo.repoInfo) {
+      await downLoadAndMoveModule(sourceDir, targetDir, moduleInfo, privateCf, isDev);
+    }
+  }
+}
+
+/**
+ * 下载模块信息并且将它移动到对应的位置
+ * @param { string } sourceDir 代码缓存文件夹
+ * @param { string } targetDir 代码要放到的目标文件夹
+ * @param { boolean } isDev 是否是dev
+ * @returns { array } moduleInfo 描述模块的信息
+ */
+async function downLoadAndMoveModule(sourceDir, targetDir,  moduleInfo, privateCf, isDev) {
+  const { repoInfo: { buildGitTag, httpRepoUrl }, path, name } = moduleInfo;
+
+  // 源码临时存在的源目录
+  let sourcePath = resolve(sourceDir, name);
+  // 源码要放到目标目录
+  const targetPath = resolve(targetDir, path);
+  // 设置模块的构建分支
+  const cloneBranch =  buildGitTag && typeof buildGitTag === 'string' ? buildGitTag : 'master';
+
+  // 检查缓存中有没有
+  const globalInstance = getGlobalInstance();
+  const moduleInCache = globalInstance.getModuleCache(httpRepoUrl, cloneBranch);
+
+  try {
+    if (!moduleInCache) {
+      // 处理仓库权限问题
+      const gitUrl = replaceGitUrlAccount(httpRepoUrl, name, privateCf);
+      await downloadRepoForGit(gitUrl, sourcePath, cloneBranch);
+      globalInstance.setModuleCache(httpRepoUrl, cloneBranch, sourcePath);
+    } else {
+      sourcePath = globalInstance.getModuleCache(httpRepoUrl, cloneBranch).dest;
+    }
+
+    if (fs.existsSync(targetPath)) {
+      shelljs.rm('-rf', `${targetPath}/*`);
+    }
+    await moveFile(sourcePath, targetPath, [
+      'node_modules',
+      '.git',
+    ]);
+  } catch (e) {
+    handleError(e, isDev);
+  }
+}
+
+module.exports = {
+  cloneModules,
+};

package/src/utils/findCssImport.js

@@ -1,30 +1,30 @@
-/* eslint-disable no-param-reassign */
-const strip = require('strip-comments');
-// 匹配规则
-const MATCH_RULE = new RegExp(/@import *(?:url\(['"]?([^'")]+)['"]?\)|['"]([^'"]+)['"]);?/g);
-
-/**
- * 获取样式文件中的@import语句
- * @param code 代码片段
- * @returns 结果数组
- */
-const findCssImports = (code) => {
-  // 将buffer转成字符串
-  code = code.toString();
-  // 去除注释
-  code = strip.block(code);
-  // 定义最后返回的结果
-  const result = [];
-  let matchList;
-  // 循环遍历代码段，直至匹配结果为空
-  while ((matchList = MATCH_RULE.exec(code))) {
-    // 存入结果数组
-    result.push(matchList?.[1] || matchList?.[2]);
-  }
-  // 返回结果
-  return result;
-};
-
-module.exports = {
-  findCssImports,
-};
+/* eslint-disable no-param-reassign */
+const strip = require('strip-comments');
+// 匹配规则
+const MATCH_RULE = new RegExp(/@import *(?:url\(['"]?([^'")]+)['"]?\)|['"]([^'"]+)['"]);?/g);
+
+/**
+ * 获取样式文件中的@import语句
+ * @param code 代码片段
+ * @returns 结果数组
+ */
+const findCssImports = (code) => {
+  // 将buffer转成字符串
+  code = code.toString();
+  // 去除注释
+  code = strip.block(code);
+  // 定义最后返回的结果
+  const result = [];
+  let matchList;
+  // 循环遍历代码段，直至匹配结果为空
+  while ((matchList = MATCH_RULE.exec(code))) {
+    // 存入结果数组
+    result.push(matchList?.[1] || matchList?.[2]);
+  }
+  // 返回结果
+  return result;
+};
+
+module.exports = {
+  findCssImports,
+};

package/src/utils/global.js

@@ -1,36 +1,36 @@
-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();
-}
-
-module.exports = {
-  getGlobalInstance,
-};
+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();
+}
+
+module.exports = {
+  getGlobalInstance,
+};

package/src/utils/handleError.js

@@ -0,0 +1,16 @@
+const { fail } = require('./log');
+
+function handleError(error, isDev = false) {
+  const errMsg = typeof error === 'object' ? error.message : error;
+  if (isDev) {
+    fail(errMsg);
+  } else {
+    fail(errMsg);
+    process.exit(1);
+  }
+}
+
+module.exports = {
+  handleError,
+};
+

package/src/utils/io.js

@@ -1,106 +1,106 @@
-const fs = require('fs');
-const path = require('path');
-/**
- * 判断目录是否为空
- * @param {string} dirname 目录名
- * @returns
- */
-const isDirEmpty = dirname => fs.promises.readdir(dirname).then(files => files.length === 0);
-
-// 判断是否是文件
-const isFile = (pathName) => {
-  try {
-    const stat = fs.lstatSync(pathName);
-    return stat.isFile();
-  } catch {
-    return false;
-  }
-};
-
-/**
- * 确保目录存在，不存在就创建一个
- * @param {*} dirname 目录名
- */
-const ensureDirExist = (dirname) => {
-  if (!fs.existsSync(dirname)) {
-    fs.mkdirSync(dirname, { recursive: true });
-  }
-};
-
-// 复制文件
-const copyFile = function (src, dest) {
-  if (fs.existsSync(dest)) {
-    fs.unlinkSync(dest);
-  }
-  const dir = dest.substr(0, dest.lastIndexOf('/'));
-  ensureDirExist(dir);
-  fs.copyFileSync(src, dest);
-};
-
-// 判断文件内容是否一致，不一致再进行拷贝
-function diffContentCopyFile(originFile, destFile) {
-  if (fs.existsSync(destFile)) {
-    const depDestContent = fs.readFileSync(destFile, 'utf8');
-    const depOriginContent = fs.readFileSync(originFile, 'utf8');
-    if (depDestContent !== depOriginContent) {
-      console.log(`拷贝${originFile}内容到${destFile}`);
-      copyFile(originFile, destFile);
-    }
-  } else {
-    console.log(`拷贝${originFile}内容到${destFile}`);
-    copyFile(originFile, destFile);
-  }
-}
-
-// 添加后缀
-function ext(filePath, extensions) {
-  let newFilePath = filePath;
-  let extPath = '';
-  // try catch需要包裹：用来处理'./lib/timer'没有后缀的情况
-  try {
-    const stat = fs.lstatSync(newFilePath);
-    if (stat.isDirectory()) {
-      extPath = newFilePath[newFilePath.length - 1] === '/' ? 'index' : '/index';
-      newFilePath += extPath;
-    }
-  } catch (e) {}
-
-  for (const ext of extensions) {
-    const file = newFilePath.endsWith(ext) ? newFilePath : newFilePath + ext;
-    if (fs.existsSync(file)) {
-      return {
-        ext,
-        extPath: extPath + ext,
-        file,
-      };
-    }
-  }
-  return {
-    ext: '',
-    extPath,
-    file: filePath,
-  };
-}
-
-// 判断文件是否在某个目录
-const fileInDir = (dir, file) => {
-  if (!fs.existsSync(dir) || !fs.existsSync(file)) {
-    return false;
-  }
-  const relativePath = path.relative(dir, file);
-  if (relativePath.startsWith('..')) {
-    return false;
-  }
-  return true;
-};
-
-
-module.exports = {
-  isDirEmpty,
-  copyFile,
-  diffContentCopyFile,
-  ensureDirExist,
-  ext,
-  fileInDir,
-  isFile,
-};
+const fs = require('fs');
+const path = require('path');
+/**
+ * 判断目录是否为空
+ * @param {string} dirname 目录名
+ * @returns
+ */
+const isDirEmpty = dirname => fs.promises.readdir(dirname).then(files => files.length === 0);
+
+// 判断是否是文件
+const isFile = (pathName) => {
+  try {
+    const stat = fs.lstatSync(pathName);
+    return stat.isFile();
+  } catch {
+    return false;
+  }
+};
+
+/**
+ * 确保目录存在，不存在就创建一个
+ * @param {*} dirname 目录名
+ */
+const ensureDirExist = (dirname) => {
+  if (!fs.existsSync(dirname)) {
+    fs.mkdirSync(dirname, { recursive: true });
+  }
+};
+
+// 复制文件
+const copyFile = function (src, dest) {
+  if (fs.existsSync(dest)) {
+    fs.unlinkSync(dest);
+  }
+  const dir = path.dirname(dest);
+  ensureDirExist(dir);
+  fs.copyFileSync(src, dest);
+};
+
+// 判断文件内容是否一致，不一致再进行拷贝
+function diffContentCopyFile(originFile, destFile) {
+  if (fs.existsSync(destFile)) {
+    const depDestContent = fs.readFileSync(destFile, 'utf8');
+    const depOriginContent = fs.readFileSync(originFile, 'utf8');
+    if (depDestContent !== depOriginContent) {
+      console.log(`拷贝${originFile}内容到${destFile}`);
+      copyFile(originFile, destFile);
+    }
+  } else {
+    console.log(`拷贝${originFile}内容到${destFile}`);
+    copyFile(originFile, destFile);
+  }
+}
+
+// 添加后缀
+function ext(filePath, extensions) {
+  let newFilePath = filePath;
+  let extPath = '';
+  // try catch需要包裹：用来处理'./lib/timer'没有后缀的情况
+  try {
+    const stat = fs.lstatSync(newFilePath);
+    if (stat.isDirectory()) {
+      extPath = newFilePath[newFilePath.length - 1] === '/' ? 'index' : '/index';
+      newFilePath += extPath;
+    }
+  } catch (e) {}
+
+  for (const ext of extensions) {
+    const file = newFilePath.endsWith(ext) ? newFilePath : newFilePath + ext;
+    if (fs.existsSync(file)) {
+      return {
+        ext,
+        extPath: extPath + ext,
+        file,
+      };
+    }
+  }
+  return {
+    ext: '',
+    extPath,
+    file: filePath,
+  };
+}
+
+// 判断文件是否在某个目录
+const fileInDir = (dir, file) => {
+  if (!fs.existsSync(dir) || !fs.existsSync(file)) {
+    return false;
+  }
+  const relativePath = path.relative(dir, file);
+  if (relativePath.startsWith('..')) {
+    return false;
+  }
+  return true;
+};
+
+
+module.exports = {
+  isDirEmpty,
+  copyFile,
+  diffContentCopyFile,
+  ensureDirExist,
+  ext,
+  fileInDir,
+  isFile,
+};

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,
+};