@tmsfe/tmskit 0.0.5 → 0.0.6

package/src/utils/io.js

@@ -1,10 +1,22 @@
 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 目录名
@@ -15,7 +27,80 @@ const ensureDirExist = (dirname) => {
   }
 };
 
+// 复制文件
+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/mpCiUtils.js

@@ -1,4 +1,3 @@
-/* eslint-disable require-jsdoc */
 const ci = require('miniprogram-ci');
 const path = require('path');
 

package/src/utils/npmUtils.js

@@ -2,55 +2,74 @@
  * 本文件主要负责项目或者分包依赖的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 dirpath = process.cwd(); // 项目根目录
+const shellJsOption = { async: false, silent: true };
+const dirPath = process.cwd(); // 项目根目录
 
-const getTarNpmFilename = targetDir => `${targetDir.replaceAll('/', '-')}.tar.gz`;
+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 || {};
 
-// 缓存npm包
-const npmCache = function (targetDir, cacheDir) {
-  if (!fs.existsSync(cacheDir)) {
-    fs.mkdirSync(cacheDir);
+  // 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;
   }
-  const tarNpmFilename = getTarNpmFilename(targetDir);
-  const tarNpmFilePath = `${cacheDir}/${tarNpmFilename}`;
-  if (fs.existsSync(tarNpmFilePath)) {
-    shell.rm('-rf', tarNpmFilePath);
-  }
-  const cmd = `tar -zcvf ${tarNpmFilePath} ./node_modules`;
-  shell.exec(cmd, { async: true, silent: true });
-  // tar -zcvf /Users/odile/.tmskit/node_modules.tar.gz  ./node_modules
-};
 
-// 获取缓存npm包
-const getNpmCache = function (targetDir, cacheDir) {
-  const tarNpmFilename = getTarNpmFilename(targetDir);
-  const tarNpmFilePath = `${cacheDir}/${tarNpmFilename}`;
-  if (fs.existsSync(tarNpmFilePath)) {
-    const cmd = `tar -zxvf ${tarNpmFilePath} -C ./`;
-    shell.exec(cmd, { async: false, silent: true });
+  // 以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);
   }
-  // tar -zxvf /Users/odile/.tmskit/node_modules.tar.gz  -C ./
+  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 npmInstallAll = async (modules, contextDir, cacheDir) => {
+const mpNpmInstallAll = async (modules, contextDir, cacheDir) => {
   const packageJsonFiles = await findAllPackageJson(modules, contextDir);
-
-  await Promise.all(packageJsonFiles.map(file => new Promise((resolve) => {
-    const dir = path.dirname(file);
-    shell.cd(dir);
-    if (!fs.existsSync(`${dir}/node_modules`)) {
-      getNpmCache(dir, cacheDir);
-    }
-    shell.exec('npx pnpm install --prod --registry http://mirrors.tencent.com/npm/', { silent: false });
-    resolve();
-    npmCache(dir, cacheDir);
-  })));
+  await Promise.all(packageJsonFiles.map(file => install(file, true, cacheDir)));
 };
 
 /**
@@ -106,10 +125,14 @@ const findFilesByFilter = (startPath, filter) => {
  */
 const findAllPackageJson = (subRoots = [], contextDir) => {
   const packageJsonName = 'package.json';         // 查找文件名
-  const cwd = contextDir || dirpath;
+  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);
 
@@ -119,8 +142,25 @@ const findAllPackageJson = (subRoots = [], contextDir) => {
   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 = {
-  npmInstallAll,
+  cloudNpmInstall,
+  mpNpmInstallAll,
   findAllPackageJson,
 };

package/src/utils/tkitUtils.js

@@ -1,13 +1,14 @@
 const loadash = require('lodash');
 const fs = require('fs');
-const { TMS_NAME, TMS_CONFIG_FILENAME, MODULE_CONFIG_FILENAME } = require('../config/constant');
+const { TMS_NAME, TMS_CONFIG_FILENAME, MODULE_CONFIG_FILENAME, TMS_PRIVATE_FILENAME } = require('../config/constant');
 const { resolve, isObject } = require('./widgets');
-const { setModuleConfig } = require('./buildAppJson');
+const { setModuleConfig, getValidModules } = require('./buildAppJson');
 const defaultTmsConfig = require('../config/defaultTmsConfig');
 const { fail } = require('./log');
+const path = require('path');
 
 /**
- * 读取tms.config.json
+ * 读取tms.config.js
  * @param env {string} 环境变量
  */
 const readTmsConfig = function (env) {
@@ -22,9 +23,45 @@ const readTmsConfig = function (env) {
   });
   // 合并默认值
   loadash.mergeWith(tmsConfig, defaultTmsConfig);
+  // modules兼容处理
+  tmsConfig.modules = convertModules(tmsConfig.modules);
   return tmsConfig;
 };
 
+// convertModules 处理默认值
+const convertModules = (modules) => {
+  const newModules = [];
+  modules.forEach((module, index) => {
+    const newModule = {};
+    if (typeof module === 'string') {
+      // 路径字符串
+      Object.assign(newModule, {
+        name: path.basename(module),
+        path: module,
+      });
+    } else if (typeof module === 'object') {
+      Object.assign(newModule, module);
+      if (module.name === undefined) {
+        newModule.name = path.basename(module.path);
+      }
+    }
+    newModules.push(newModule);
+  });
+  return newModules;
+};
+
+/**
+ * 读取tms.private.js
+ */
+const readTmsPrivateCf = function () {
+  let tmsPrivateCg;
+  const tmsPrivatePath = resolve(TMS_PRIVATE_FILENAME);
+  if (fs.existsSync(tmsPrivatePath)) {
+    tmsPrivateCg = require(tmsPrivatePath);
+  }
+  return tmsPrivateCg;
+};
+
 /**
  * 从tms.config.json中检索用户传入的有效modules
  * @param { object } tmsConfig
@@ -32,7 +69,7 @@ const readTmsConfig = function (env) {
  * @returns
  */
 const checkModules = function (tmsConfig, modules) {
-  const targetModules =  [];
+  const targetModules = [];
   modules.forEach((moduleName) => {
     const module = tmsConfig.modules.find(module => module.name === moduleName);
     module && targetModules.push(module);
@@ -51,22 +88,29 @@ const checkModules = function (tmsConfig, modules) {
  * @param {string} moduleDir
  * @returns
  */
-const tmsModulesMergeLocalModuleCfg = (modules, appName, moduleDir) => {
+const tmsModulesMergeLocalModuleCfg = (modules, appName) => {
   const newModules = [];
   modules.forEach(({ path: relativePath, name: moduleName }, moduleIndex) => {
     const moduleConfigPath = resolve(relativePath, MODULE_CONFIG_FILENAME);
     if (fs.existsSync(moduleConfigPath)) {
-      let moduleConfigContent = fs.readFileSync(moduleConfigPath, 'utf-8');
-      moduleConfigContent = setModuleConfig(moduleConfigContent, appName, moduleDir);
-      const moduleContentArr = isObject(moduleConfigContent) ? [moduleConfigContent] : moduleConfigContent;
-      moduleContentArr.forEach(({ name }, moduleContentArrIndex) => {
-        if (name === moduleName) {
-          newModules.push({
-            ...modules[moduleIndex],
-            ...moduleContentArr[moduleContentArrIndex],
-          });
-        }
-      });
+      try {
+        let moduleConfigContent = fs.readFileSync(moduleConfigPath, 'utf-8');
+        moduleConfigContent = setModuleConfig(moduleConfigContent, appName);
+        const moduleContentArr = isObject(moduleConfigContent) ? [moduleConfigContent] : moduleConfigContent;
+        getValidModules(moduleContentArr).forEach(({ name }, moduleContentArrIndex) => {
+          if (name === moduleName) {
+            newModules.push({
+              ...modules[moduleIndex],
+              ...moduleContentArr[moduleContentArrIndex],
+            });
+          }
+        });
+      } catch (e) {
+        fail(`${moduleConfigPath}配置错误: ${e}`);
+        newModules.push({
+          ...modules[moduleIndex],
+        });
+      }
     } else {
       newModules.push({
         ...modules[moduleIndex],
@@ -76,9 +120,39 @@ const tmsModulesMergeLocalModuleCfg = (modules, appName, moduleDir) => {
   return newModules;
 };
 
+/**
+ * 分包依赖了分包的模块 合并所依赖的modules
+ * @param { object } tmsConfig
+ * @param {array} modules
+ * @param {string} moduleDir
+ * @returns
+ */
+const subModulesMergeDepModules = (tmsConfig, modules) => {
+  const moduleNames = [];
+  modules.forEach(({ name: moduleName }) => {
+    moduleNames.push(moduleName);
+  });
+  let mergeModules = modules;
+  let isOver = true;
+  modules.forEach(({ dependencies: dependencyModules }) => {
+    dependencyModules?.forEach((item) => {
+      // 如果所有模块的dep都在moduleNames内，则所有依赖都齐了
+      // 否则递归处理，根据name找到相关配置加到modules里
+      if (moduleNames.indexOf(item) === -1) {
+        isOver = false;
+        const tmpModules = checkModules(tmsConfig, [...new Set([item])]);
+        mergeModules = [...mergeModules, ...tmpModules];
+        mergeModules = tmsModulesMergeLocalModuleCfg(mergeModules, tmsConfig.appName);
+      }
+    });
+  });
+  return isOver ? mergeModules : subModulesMergeDepModules(tmsConfig, mergeModules);
+};
 
 module.exports = {
   readTmsConfig,
+  readTmsPrivateCf,
   checkModules,
   tmsModulesMergeLocalModuleCfg,
+  subModulesMergeDepModules,
 };

package/src/utils/widgets.js

@@ -7,7 +7,7 @@ const fs = require('fs');
 const shelljs = require('shelljs');
 const download = require('download-git-repo');
 const chalk = require('chalk');
-const shelljsOptons =  { slient: true };
+const shelljsOptions =  { slient: true };
 
 // 获取当前目录
 const cwd = process.cwd();
@@ -96,7 +96,7 @@ function downloadRepo(dest, downloadOptions = { repoUrl: '', gitUrl: '', branch:
 function downloadRepoForGit(url, dest, branch) {
   const cwd = process.cwd();
 
-  return new Promise((resolve) => {
+  return new Promise((resolve, reject) => {
     // 如果目标目录不存在
     if (fs.existsSync(dest)) {
       shelljs.rm('-rf', path.join(dest));
@@ -105,7 +105,10 @@ function downloadRepoForGit(url, dest, branch) {
     shelljs.mkdir('-p', dest);
     shelljs.cd(dest);
 
-    shelljs.exec(`git clone ${url} ${dest} --branch ${branch} --depth 1`, shelljsOptons);
+    const gitCloneRes = shelljs.exec(`git clone ${url} ${dest} --branch ${branch} --depth 1`, shelljsOptions);
+    if (gitCloneRes.code !== 0) {
+      reject(gitCloneRes.stderr);
+    }
 
     shelljs.cd(cwd);
     resolve();
@@ -129,22 +132,16 @@ const cost = start => Date.now() - start;
 function createTask(task, startText, endText) {
   return async (...args) => {
     const start = Date.now();
-    let result;
 
     const spinner = ora(startText);
+
     spinner.start();
+    console.log('\n');
 
-    try {
-      result = await task(...args);
-    } catch (e) {
-      result = e;
-      console.log(chalk.red(e));
+    const result = await task(...args);
 
-      process.exit(-1);
-    } finally {
-      endText && spinner.succeed(`${endText}, ${cost(start)}ms`);
-      spinner.stop();
-    }
+    endText && spinner.succeed(`${endText}, ${cost(start)}ms`);
+    spinner.stop();
 
     return result;
   };

package/rollup.config.js

@@ -1,179 +0,0 @@
-import path from 'path';
-import ts from 'rollup-plugin-typescript2';
-import babel from '@rollup/plugin-babel';
-import json from '@rollup/plugin-json';
-import replace from 'rollup-plugin-replace';
-import nodeResolve from 'rollup-plugin-node-resolve';
-import commonjs from '@rollup/plugin-commonjs';
-
-if (!process.env.TARGET) {
-  throw new Error('TARGET package must be specified via --environment flag.');
-}
-
-// 指定包地址
-const packageDir = path.resolve(__dirname);
-// 包名
-const name = path.basename(packageDir);
-// 环境
-const interEnv = process.env.INTER_ENV || 'public';
-
-// eslint-disable-next-line
-const packageJson = require('./package.json');
-
-const packageOptions = packageJson.buildOptions || {};
-
-function resolve(name) { // eslint-disable-line
-  return path.resolve(packageDir, name);
-}
-
-const outputConfig = {
-  esm: {
-    dir: resolve('dist'),
-    entryFileNames: '[name].js',
-    format: 'es',
-  },
-  'esm-browser': {
-    dir: resolve('dist'),
-    entryFileNames: '[name].esm-browser.js',
-    format: 'es',
-  },
-  cjs: {
-    dir: resolve('dist'),
-    entryFileNames: '[name].cjs.js',
-    format: 'cjs',
-  },
-  global: {
-    dir: resolve('dist'),
-    entryFileNames: '[name].global.js',
-    format: 'iife',
-  },
-};
-
-const defaultFormats = ['esm'];
-// 打包格式
-const packageFormats = packageOptions.formats || defaultFormats;
-
-const packageConfigs = packageFormats.map(format => createConfig(format, outputConfig[format]));
-
-export default packageConfigs;
-
-/**
- * format rollup package configuration object
- * @param {string} format 文件打包格式
- * @param {object} output 输出对象
- * @param {array} plugins 插件
- * @returns {object} rollup配置对象
- */
-function createConfig(format, output, plugins = []) {
-  if (!output) {
-    // eslint-disable-next-line
-    console.log(require('chalk').yellow(`invalid format: "${format}"`));  // eslint-disable-line no-console
-    process.exit(1);
-  }
-
-  output.sourceMap = true;  // eslint-disable-line
-  output.externalLiveBindings = false;  // eslint-disable-line
-
-  // 兼容不同的包的入口文件 -- 后面会统一为index.ts
-  const entryFile = setEntryFile(name);
-
-  // 定制化cjs的插件和esmodule的插件。
-  const extralPlugin = setEsPlugin(output.format);
-
-  return {
-    input: entryFile,
-    output,
-    external: [],
-    plugins: [
-      json({
-        namedExports: false,
-      }),
-      commonjs({
-        ignoreDynamicRequires: true,
-        // include: 'node_modules/**', // Default: undefined
-        browser: true,
-      }),
-      babel({
-        plugins: ['@babel/plugin-proposal-nullish-coalescing-operator', '@babel/plugin-proposal-optional-chaining'],
-        // exclude: ['node_modules/**'],
-      }),
-      // terser(),
-      createReplacePlugin(),
-      ...extralPlugin,
-      ...plugins,
-    ],
-    onwarn: (msg, warn) => {
-      if (!/Circular/.test(msg)) {
-        warn(msg);
-      }
-    },
-    treeshake: {
-      moduleSideEffects: false,
-    },
-  };
-}
-
-/**
- * 兼容现在的包会存在不同入口的情况。 后面会统一为index.ts
- * @param {  string } packageName 包名称
- * @returns { Object } entryFile
- */
-function setEntryFile(packageName) {
-  let entryFile = resolve('src/index.js');
-
-  switch (packageName) {
-    case 'tms-core':
-      entryFile = {
-        index: resolve('src/index'),
-        request: resolve('src/request'),
-        cloudService: resolve('src/cloudService'),
-      };
-      if (interEnv !== 'public') {
-        entryFile['index-proxy'] = resolve('src/index-proxy');
-      }
-      break;
-    case 'tms-websdk':
-      entryFile = resolve('src/index.ts');
-      break;
-    default:
-      entryFile = resolve('src/index.js');
-  };
-
-  return entryFile;
-}
-
-/**
- * 定制化cjs和esmodule的插件
- * @param { string } format 打包格式
- * @returns { Array<plugin> } 插件数组
- */
-function setEsPlugin(format) {
-  const extralPlugins = [];
-
-
-  if (format.indexOf('es') > -1) {
-    extralPlugins.push(ts({
-      tsconfig: resolve('tsconfig.json'),
-    }));
-  };
-  if (format.indexOf('iife') > -1) {
-    extralPlugins.push(nodeResolve({ jsnext: true, preferBuiltins: true, browser: true }));
-  }
-  return extralPlugins;
-}
-
-/**
- * 创建变量替换插件
- * @returns {function} 插件函数
- */
-function createReplacePlugin() {
-  const replacements = {
-    tmsCore: interEnv === 'public' ? '@tmsfe/tms-core' : '@tmsfe/tms-core',
-    INTER_ENV_VB: JSON.stringify(interEnv || 'private'),
-  };
-
-  return replace({
-    values: replacements,
-    preventAssignment: true,
-  });
-}