@tmsfe/tmskit 0.0.7 → 0.0.9-beta.1

package/src/utils/io.js

@@ -1,106 +1,107 @@
-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,
-};
+const fs = require('fs');
+const path = require('path');
+const { info } = require('../utils/log');
+/**
+ * 判断目录是否为空
+ * @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) {
+      info(`拷贝${originFile}内容到${destFile}`);
+      copyFile(originFile, destFile);
+    }
+  } else {
+    info(`拷贝${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,47 @@
-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));
+};
+
+const info = (...args) => console.log(...args);
+
+module.exports = {
+  fail,
+  succeed,
+  warn,
+  info,
+};

package/src/utils/widgets.js

@@ -1,167 +1,178 @@
-
-const program = require('commander');
-const leven = require('leven');
-const ora = require('ora');
-const path = require('path');
-const fs = require('fs');
-const shelljs = require('shelljs');
-const download = require('download-git-repo');
-const chalk = require('chalk');
-const shelljsOptions =  { slient: true };
-
-// 获取当前目录
-const cwd = process.cwd();
-function resolve(...args) {
-  return path.resolve(cwd, ...args);
-};
-
-/**
- * 封装logs
- * @returns {Undefined} 无需返回值
- */
-const log = (...args) => console.log(...args);
-
-/**
- * 用户输入命令时，进行提示
- * @param {String} unknownCommand 非预期的命令
- * @returns {Undefined} 无需返回值
- */
-const suggestCommands = (unknownCommand) => {
-  const availableCommands = program.commands.map(cmd => cmd._name);
-
-  let suggestion;
-  availableCommands.forEach((cmd) => {
-    const isBestMatch = leven(cmd, unknownCommand) < leven(suggestion || '', unknownCommand);
-    if (leven(cmd, unknownCommand) < 3 && isBestMatch) {
-      suggestion = cmd;
-    }
-  });
-
-  if (suggestion) {
-    log(`  ${chalk.red(`Did you mean ${chalk.yellow(suggestion)}?`)}`);
-  }
-};
-
-/**
- * 判断变量是否是一个数组
- * @param { unknown } obj 变量
- * @returns { boolean } 是否是一个数组
- */
-function isObject(obj) {
-  return Object.prototype.toString.call(obj) === '[object Object]';
-}
-
-/**
- * 判断变量是否是一个对象
- * @param { unknown } obj 变量
- * @returns { boolean } 是否是一个对象
- */
-function isArray(obj) {
-  return Object.prototype.toString.call(obj) === '[object Array]';
-}
-
-/**
- * 下载模块到目标目录
- * @param { string } dest 目标地址
- * @param { object } downloadOptions 模块下载配置 { repoUrl-仓库地址, gitUrl-git地址, branch-分支或者tag }
- * @returns { undefined } no return
- */
-function downloadRepo(dest, downloadOptions = { repoUrl: '', gitUrl: '', branch: '' }) {
-  const { repoUrl, gitUrl, branch } = downloadOptions;
-
-  if (fs.existsSync(dest)) {
-    shelljs.rm('-rf', 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);
-      }
-
-      resolve();
-    });
-  });
-}
-
-/**
- * 下载模块到目标目录备用方案
- * @param { string } url 模块地址
- * @param { string } dest 目标地址
- * @param { string } branch 分支名
- * @returns { undefined } no return
- */
-function downloadRepoForGit(url, 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);
-
-    const gitCloneRes = shelljs.exec(`git clone ${url} ${dest} --branch ${branch} --depth 1`, shelljsOptions);
-    if (gitCloneRes.code !== 0) {
-      reject(gitCloneRes.stderr);
-    }
-
-    shelljs.cd(cwd);
-    resolve();
-  });
-}
-
-/**
- * 计算各项任务耗时
- * @param {Number} start 任务开始时间
- * @returns {Undefined} 无需返回值
- */
-const cost = start => Date.now() - start;
-
-/**
- * 创建构建子任务
- * @param {Function} task 子任务执行函数
- * @param {String} startText 任务开始前提示语
- * @param {String} endText 任务结束后提示语
- * @returns {Undefined} 无需返回值
- */
-function createTask(task, startText, endText) {
-  return async (...args) => {
-    const start = Date.now();
-
-    const spinner = ora(startText);
-
-    spinner.start();
-    console.log('\n');
-
-    const result = await task(...args);
-
-    endText && spinner.succeed(`${endText}, ${cost(start)}ms`);
-    spinner.stop();
-
-    return result;
-  };
-};
-
-/**
- * 字符串驼峰化处理
- * @param {String} str 需要处理的字符串
- * @returns {String} 经过驼峰处理的字符串
- */
-const camelize = str => str.replace(/-(\w)/g, (a, c) => (c ? c.toUpperCase() : ''));
-
-module.exports = {
-  resolve,
-  log,
-  isObject,
-  isArray,
-  createTask,
-  downloadRepo,
-  downloadRepoForGit,
-  suggestCommands,
-  camelize,
-};
+
+const program = require('commander');
+const leven = require('leven');
+const ora = require('ora');
+const path = require('path');
+const fs = require('fs');
+const shelljs = require('shelljs');
+const { info } = require('./log');
+const chalk = require('chalk');
+const shelljsOptions =  { slient: true, async: false };
+
+// 获取当前目录
+const cwd = process.cwd();
+function resolve(...args) {
+  return path.resolve(cwd, ...args);
+};
+
+
+/**
+ * 用户输入命令时，进行提示
+ * @param {String} unknownCommand 非预期的命令
+ * @returns {Undefined} 无需返回值
+ */
+const suggestCommands = (unknownCommand) => {
+  const availableCommands = program.commands.map(cmd => cmd._name);
+
+  let suggestion;
+  availableCommands.forEach((cmd) => {
+    const isBestMatch = leven(cmd, unknownCommand) < leven(suggestion || '', unknownCommand);
+    if (leven(cmd, unknownCommand) < 3 && isBestMatch) {
+      suggestion = cmd;
+    }
+  });
+
+  if (suggestion) {
+    info(`  ${chalk.red(`Did you mean ${chalk.yellow(suggestion)}?`)}`);
+  }
+};
+
+/**
+ * 判断变量是否是一个数组
+ * @param { unknown } obj 变量
+ * @returns { boolean } 是否是一个数组
+ */
+function isObject(obj) {
+  return Object.prototype.toString.call(obj) === '[object Object]';
+}
+
+/**
+ * 判断变量是否是一个对象
+ * @param { unknown } obj 变量
+ * @returns { boolean } 是否是一个对象
+ */
+function isArray(obj) {
+  return Object.prototype.toString.call(obj) === '[object Array]';
+}
+
+
+/**
+ * 下载模块代码
+ * @param { string } url 模块地址
+ * @param { string } dest 目标地址
+ * @param { string } branch 分支名
+ * @returns { undefined } no return
+ */
+function downloadRepoForGit(url, 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 clone ${url} ${dest} --branch ${branch} --depth 1`,  { silent: true }, (code, stdout, stderr) => {
+      if (code !== 0) {
+        reject(stderr);
+      }
+      shelljs.cd(cwd);
+      resolve();
+    });
+  });
+}
+
+
+/**
+ * pull模块代码
+ * @param { string } dest 下载代码的路径
+ * @param { string } branch 分支名
+ * @returns { undefined } no return
+ */
+function pullRepoForGit(dest, branch) {
+  const cwd = process.cwd();
+  return new Promise((resolve, reject) => {
+    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();
+    });
+  });
+}
+
+/**
+ * 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();
+      },
+    );
+  });
+}
+
+/**
+ * 计算各项任务耗时
+ * @param {Number} start 任务开始时间
+ * @returns {Undefined} 无需返回值
+ */
+const cost = start => Date.now() - start;
+
+/**
+ * 创建构建子任务
+ * @param {Function} task 子任务执行函数
+ * @param {String} startText 任务开始前提示语
+ * @param {String} endText 任务结束后提示语
+ * @returns {Undefined} 无需返回值
+ */
+function createTask(task, startText, endText) {
+  return async (...args) => {
+    const start = Date.now();
+
+    const spinner = ora(startText);
+
+    spinner.start();
+    info('\n');
+
+    const result = await task(...args);
+
+    endText && spinner.succeed(`${endText}, ${cost(start)}ms`);
+    spinner.stop();
+
+    return result;
+  };
+};
+
+/**
+ * 字符串驼峰化处理
+ * @param {String} str 需要处理的字符串
+ * @returns {String} 经过驼峰处理的字符串
+ */
+const camelize = str => str.replace(/-(\w)/g, (a, c) => (c ? c.toUpperCase() : ''));
+
+module.exports = {
+  resolve,
+  isObject,
+  isArray,
+  createTask,
+  downloadRepoForGit,
+  pullRepoForGit,
+  suggestCommands,
+  camelize,
+  npmInstall,
+};