@tmsfe/tmskit 0.0.5-beta.5 → 0.0.7

package/src/utils/buildAppJson.js

@@ -1,200 +1,221 @@
-const fs = require('fs');
-const { DEFAULT_MODULE_DIR, MODULE_CONFIG_FILENAME, MODULE_CONFIG_INVALID_KEY } = require('../config/constant');
-const { fail } = require('./log');
-const { resolve, isObject, isArray } = require('./widgets');
-
-/**
- * 获取每个模块下面的信息，并且收集，后续更新到appJson里面
- * @param { object } file 操作目录下面所有的文件
- * @param { string } appName 小程序的名称
- */
-function setModuleConfig(file, appName, moduleDir) {
-  const content = file.contents ? JSON.parse(file.contents.toString()) : JSON.parse(file);
-
-  if (isObject(content)) {
-    content.root = content.root.indexOf(moduleDir) > -1 ? content.root : `${moduleDir}/${content.root}`;
-  }
-
-  if (isArray(content)) {
-    let i = content.length - 1;
-    while (i >= 0) {
-      let current = content[i];
-      current.root = current.root.indexOf(moduleDir) > -1 ? current.root : `${moduleDir}/${current.root}`;
-
-      if (appName && current.mpConfig && current.mpConfig[appName]) {
-        current = { ...current, ...current.mpConfig[appName] };
-      }
-
-      delete current.mpConfig;
-      delete current.isSubpackages;
-
-      content[i] = current;
-      i--; // eslint-disable-line
-    }
-  }
-  return content;
-}
-
-/**
- * 递归获取本地所有模块的配置信息
- */
-function getLocalModuleConfig(modules = [], appName, moduleDir, moduleConfigFilename) {
-  const modulesConfig = {};
-
-  modules.forEach(({ path }) => {
-    const moduleConfigPath = resolve(path, moduleConfigFilename);
-    if (fs.existsSync(moduleConfigPath)) {
-      const content = fs.readFileSync(moduleConfigPath, 'utf-8');
-      modulesConfig[moduleConfigPath] = setModuleConfig(content, appName, moduleDir);
-    }
-  });
-  return modulesConfig;
-}
-
-/**
- * 更新appJson里面的首页配置
- * @param { object } appJson appJson信息
- * @param { array } mainPackages 小程序主包信息
- * @returns { object } appJson小程序主页配置信息
- */
-function updateMainPackages(appJson, mainPackages = []) {
-  let foundMainPackages = appJson.subpackages.filter(subpackage => mainPackages.includes(subpackage.name));
-  if (foundMainPackages.length === 0) {
-    // 没找到主包
-    foundMainPackages = [appJson.subpackages[0]];
-  }
-  // 拼装 app.pages
-  foundMainPackages.forEach((subpackage) => {
-    if (!subpackage.pages || !subpackage.pages.length) {
-      fail(`主包 ${subpackage} 不能没有 pages`);
-      process.exit(-1);
-    }
-    subpackage.pages.forEach((page) => {
-      appJson.pages.push(`${subpackage.root}/${page}`);
-    });
-    if (subpackage.plugins) {
-      Object.assign(appJson.plugins, subpackage.plugins);
-    }
-  });
-
-  // 去掉 subpackages 中的主包配置
-  const foundMainPackageNames = foundMainPackages.map(item => item.name);
-  // eslint-disable-next-line
-  appJson.subpackages = appJson.subpackages.filter(subpackage => !foundMainPackageNames.includes(subpackage.name));
-
-  return appJson;
-}
-/**
- * 获取app.json内容
- * @param {string} sourceAppJsonPath
- * @returns
- */
-const getAppJsonContent = (sourceAppJsonPath) => {
-  if (!fs.existsSync(sourceAppJsonPath)) {
-    fail(`当前路径 ${sourceAppJsonPath} 没找到app.json`);
-    process.exit(1);
-  }
-  const appJson = JSON.parse(fs.readFileSync(sourceAppJsonPath), 'utf-8');
-  // 加入默认值
-  appJson.subpackages = [];
-  appJson.pages = [];
-  // appJson.plugins = {};
-  delete appJson.entranceDeclare;
-  return appJson;
-};
-/**
- * 更新app.json中的subpackages
- * @param {Object} appJson
- * @param {Object} modulesConfig
- */
-const updateSubpackages = (appJson, modulesConfig) => {
-  // eslint-disable-next-line
-  for (const name in modulesConfig) {
-    const moduleInfo = isObject(modulesConfig[name]) ? [modulesConfig[name]] : modulesConfig[name];
-    // eslint-disable-next-line
-    appJson.subpackages = appJson.subpackages.concat(moduleInfo);
-  }
-};
-
-/**
- * 处理合并subpackages后的appjson, 整理重复不合法的地方
- * @param {Object} appJson appjson
- */
-const processAppJson = (appJson) => {
-  const { subpackages } = appJson;
-  const pluginsMap = {};
-  Object.keys(appJson.plugins || {}).forEach(key => pluginsMap[key] = ['app.json']);
-  const subps = subpackages.map((subp) => {
-    const invalidKeys = [];
-    Object.keys(subp).forEach((key) => {
-      if (key === 'plugins') {
-        Object.keys(subp.plugins).forEach((pk) => {
-          pluginsMap[pk] ? pluginsMap[pk].push(`分包${subp.name}`) : pluginsMap[pk] = [`分包${subp.name}`];
-        });
-        return;
-      }
-      if (MODULE_CONFIG_INVALID_KEY.indexOf(key) > -1) {
-        // 如果分包配置中有不支持的key，则错误提醒
-        invalidKeys.push(key);
-        return;
-      }
-      if (['requiredBackgroundModes', 'embeddedAppIdList'].indexOf(key) > -1) {
-        // 提到appjson最上层处理
-        const preVal = appJson[key];
-        // eslint-disable-next-line
-        preVal ? appJson[key] = Array.from(new Set(preVal
-          // eslint-disable-next-line
-          .slice(0).concat(subp[key]))) : appJson[key] = subp[key].slice(0);
-        return;
-      }
-    });
-    if (invalidKeys.length) {
-      fail(`不支持分包${subp?.name}配置${invalidKeys.join(',')}\n`);
-    }
-    // eslint-disable-next-line
-    invalidKeys.concat(['requiredBackgroundModes', 'embeddedAppIdList']).forEach(k => delete subp[k]);
-    return subp;
-  });
-  // 如果plugins重复，则错误提示
-  const pluginsErrMsg = Object.keys(pluginsMap).map((pk) => {
-    if (pluginsMap[pk].length > 1) {
-      return `${pluginsMap[pk].join(',')}重复配置plugin(${pk});`;
-    }
-    return '';
-  })
-    .reduce((pre, cur) => pre + cur, '');
-  if (pluginsErrMsg) {
-    fail(pluginsErrMsg);
-  }
-  // eslint-disable-next-line
-  appJson.subpackages = subps;
-};
-
-
-/**
- * 动态生成编译后的app.json
- * @param {object} tmsConfig
- * @param {array} modules
- * @returns
- */
-function buildOutputAppJson(tmsConfig, modules) {
-  // 获取当前 modules 下的所有子模块的配置内容
-  const modulesConfig = getLocalModuleConfig(modules, tmsConfig.appName, DEFAULT_MODULE_DIR, MODULE_CONFIG_FILENAME);
-  // 获取app.json的配置
-  const appJson = getAppJsonContent(resolve('./app.json'));
-  // 更新app.json中的subpackages
-  updateSubpackages(appJson, modulesConfig);
-  // 处理appJson中重复||冲突的地方
-  processAppJson(appJson);
-  // 更新主包，需在subpackages处理完成后执行， pages/
-  updateMainPackages(appJson, tmsConfig.mainPackages, DEFAULT_MODULE_DIR);
-
-  fs.writeFileSync(resolve(`${tmsConfig.outputDir}/app.json`), JSON.stringify(appJson, null, 2), 'utf8');
-
-  return appJson;
-}
-
-module.exports = {
-  setModuleConfig,
-  buildOutputAppJson,
-};
+const fs = require('fs');
+const { MODULE_CONFIG_FILENAME, MODULE_CONFIG_INVALID_KEY } = require('../config/constant');
+const { fail } = require('./log');
+const { resolve, isObject, isArray } = require('./widgets');
+const { handleError } = require('./handleError');
+
+/**
+ * 获取每个模块下面的信息，并且收集，后续更新到appJson里面
+ * @param { object } file 操作目录下面所有的文件
+ * @param { string } appName 小程序的名称
+ */
+
+function setModuleConfig(file, appName) {
+  const content = file.contents ? JSON.parse(file.contents.toString()) : JSON.parse(file);
+
+
+  if (isArray(content)) {
+    let i = content.length - 1;
+    while (i >= 0) {
+      let current = content[i];
+
+      if (appName && current.mpConfig && current.mpConfig[appName]) {
+        current = { ...current, ...current.mpConfig[appName] };
+      }
+
+      delete current.mpConfig;
+      delete current.isSubpackages;
+
+      content[i] = current;
+      i--; // eslint-disable-line
+    }
+  }
+  return content;
+}
+
+/**
+ * 递归获取本地所有模块的配置信息
+ */
+function getLocalModuleConfig(modules = [], appName, moduleConfigFilename) {
+  const modulesConfig = {};
+
+  modules.forEach(({ path }) => {
+    const moduleConfigPath = resolve(path, moduleConfigFilename);
+    if (fs.existsSync(moduleConfigPath)) {
+      const content = fs.readFileSync(moduleConfigPath, 'utf-8');
+      modulesConfig[moduleConfigPath] = setModuleConfig(content, appName);
+    }
+  });
+
+  return modulesConfig;
+}
+
+/**
+ * 更新appJson里面的首页配置
+ * @param { object } appJson appJson信息
+ * @param { array } mainPackages 小程序主包信息
+ * @returns { object } appJson小程序主页配置信息
+ */
+function updateMainPackages(appJson, mainPackages = []) {
+  let foundMainPackages = appJson.subpackages.filter(subpackage => mainPackages.includes(subpackage.name));
+  if (foundMainPackages.length === 0) {
+    // 没找到主包
+    foundMainPackages = [appJson.subpackages[0]];
+  }
+  // 拼装 app.pages
+  foundMainPackages.forEach((subpackage) => {
+    if (!subpackage.pages || !subpackage.pages.length) {
+      fail(`主包 ${subpackage} 不能没有 pages`);
+      process.exit(-1);
+    }
+    subpackage.pages.forEach((page) => {
+      appJson.pages.push(`${subpackage.root}/${page}`);
+    });
+    if (subpackage.plugins) {
+      Object.assign(appJson.plugins, subpackage.plugins);
+    }
+  });
+
+  // 去掉 subpackages 中的主包配置
+  const foundMainPackageNames = foundMainPackages.map(item => item.name);
+  // eslint-disable-next-line
+  appJson.subpackages = appJson.subpackages.filter(subpackage => !foundMainPackageNames.includes(subpackage.name));
+
+  return appJson;
+}
+/**
+ * 获取app.json内容
+ * @param {string} sourceAppJsonPath
+ * @returns
+ */
+const getAppJsonContent = (sourceAppJsonPath) => {
+  if (!fs.existsSync(sourceAppJsonPath)) {
+    fail(`当前路径 ${sourceAppJsonPath} 没找到app.json`);
+    process.exit(1);
+  }
+  const appJson = JSON.parse(fs.readFileSync(sourceAppJsonPath), 'utf-8');
+  // 加入默认值
+  appJson.subpackages = [];
+  appJson.pages = [];
+  // appJson.plugins = {};
+  delete appJson.entranceDeclare;
+  return appJson;
+};
+/**
+ * 更新app.json中的subpackages
+ * @param {Object} appJson
+ * @param {Object} modulesConfig
+ */
+const updateSubpackages = (appJson, modulesConfig) => {
+  // eslint-disable-next-line
+  for (const name in modulesConfig) {
+    const moduleInfo = isObject(modulesConfig[name]) ? [modulesConfig[name]] : modulesConfig[name];
+    // 过滤 pages 为空的情况
+    const validModules = getValidModules(moduleInfo);
+    // eslint-disable-next-line
+    appJson.subpackages = appJson.subpackages.concat(validModules);
+  }
+};
+/**
+ * 过滤页面为空的分包
+ * @param {Array} moduleCfg 模块配置内容
+ * @returns pages不为空的分包
+ */
+const getValidModules = (moduleCfg) => {
+  // 过滤 pages 为空的情况
+  const validModules = moduleCfg.filter(item => item.pages.length > 0);
+  return validModules;
+};
+
+/**
+ * 处理合并subpackages后的appjson, 整理重复不合法的地方
+ * @param {Object} appJson appjson
+ */
+const processAppJson = (appJson) => {
+  const { subpackages } = appJson;
+  const pluginsMap = {};
+  Object.keys(appJson.plugins || {}).forEach(key => pluginsMap[key] = ['app.json']);
+  const subps = subpackages.map((subp) => {
+    const invalidKeys = [];
+    Object.keys(subp).forEach((key) => {
+      if (key === 'dependencies') {
+        // eslint-disable-next-line
+        delete subp.dependencies;
+        return;
+      }
+      if (key === 'plugins') {
+        Object.keys(subp.plugins).forEach((pk) => {
+          pluginsMap[pk] ? pluginsMap[pk].push(`分包${subp.name}`) : pluginsMap[pk] = [`分包${subp.name}`];
+        });
+        return;
+      }
+      if (MODULE_CONFIG_INVALID_KEY.indexOf(key) > -1) {
+        // 如果分包配置中有不支持的key，则错误提醒
+        invalidKeys.push(key);
+        return;
+      }
+      if (['requiredBackgroundModes', 'embeddedAppIdList'].indexOf(key) > -1) {
+        // 提到appjson最上层处理
+        const preVal = appJson[key];
+        // eslint-disable-next-line
+        preVal ? appJson[key] = Array.from(new Set(preVal
+          // eslint-disable-next-line
+          .slice(0).concat(subp[key]))) : appJson[key] = subp[key].slice(0);
+        return;
+      }
+    });
+    if (invalidKeys.length) {
+      fail(`不支持分包${subp?.name}配置${invalidKeys.join(',')}\n`);
+    }
+    // eslint-disable-next-line
+    invalidKeys.concat(['requiredBackgroundModes', 'embeddedAppIdList']).forEach(k => delete subp[k]);
+    return subp;
+  });
+  // 如果plugins重复，则错误提示
+  const pluginsErrMsg = Object.keys(pluginsMap).map((pk) => {
+    if (pluginsMap[pk].length > 1) {
+      return `${pluginsMap[pk].join(',')}重复配置plugin(${pk});`;
+    }
+    return '';
+  })
+    .reduce((pre, cur) => pre + cur, '');
+  if (pluginsErrMsg) {
+    fail(`plugins配置出现错误:${pluginsErrMsg}`);
+  }
+  // eslint-disable-next-line
+  appJson.subpackages = subps;
+};
+
+
+/**
+ * 动态生成编译后的app.json
+ * @param {object} tmsConfig
+ * @param {array} modules
+ * @returns
+ */
+function buildOutputAppJson(tmsConfig, modules, isDev) {
+  try {
+    // 获取当前 modules 下的所有子模块的配置内容
+    const modulesConfig = getLocalModuleConfig(modules, tmsConfig.appName, MODULE_CONFIG_FILENAME);
+    // 获取app.json的配置
+    const appJson = getAppJsonContent(resolve('./app.json'));
+    // 更新app.json中的subpackages
+    updateSubpackages(appJson, modulesConfig);
+    // 处理appJson中重复||冲突的地方
+    processAppJson(appJson);
+    // 更新主包，需在subpackages处理完成后执行， pages/
+    updateMainPackages(appJson, tmsConfig.mainPackages);
+
+    fs.writeFileSync(resolve(`${tmsConfig.outputDir}/app.json`), JSON.stringify(appJson, null, 2), 'utf8');
+
+    return appJson;
+  } catch (e) {
+    handleError(`生成app.json出现错误: ${e}`, isDev);
+  }
+}
+
+module.exports = {
+  setModuleConfig,
+  getValidModules,
+  buildOutputAppJson,
+};

package/src/utils/checkDependencies.js

@@ -1,77 +1,77 @@
-const fs = require('fs');
-const semver = require('semver');
-const { resolve } = require('./widgets');
-const path = require('path');
-const { fail } = require('./log');
-const shelljs = require('shelljs');
-
-const getLatestVersion = (npmName) => {
-  const data = shelljs.exec(`npm view ${npmName} version`);
-  return data.stdout || '0.0.0';
-};
-
-/**
- * 检查package.json的依赖大于node_module的版本，则返回true
- * @param {*} modules 模块
- * @param {*} cwd  待检查package.json所在的目录 (eg: 当前执行脚本的目录)
- * @param {*} outputDir  待检查node_modules存放的目录 （eg: dist/node_modules）
- * @returns
- */
-const checkDependencies = (modules, cwd, outputDir) => {
-  // 步骤1. 收集package.json
-  const packageJsonName = 'package.json';  // 查找文件名
-  // 1.1根目录的package.json
-  const packageArr = [
-    {
-      srcPackageDir: path.join(cwd, packageJsonName),
-      destNpmDir: resolve(outputDir, 'node_modules'),
-    },
-  ];
-  // 1.2模块的package.json
-  modules.forEach((item) => {
-    const srcPackageDir = path.join(cwd, item.path, 'package.json');
-    if (fs.existsSync(srcPackageDir)) {
-      packageArr.push({
-        srcPackageDir,
-        destNpmDir: resolve(outputDir, item.root, 'node_modules'),
-      });
-    }
-  });
-
-  // 步骤2. 比较package.json的依赖与node_modules依赖的版本号
-  for (const item of packageArr) {
-    const packageJson = fs.readFileSync(item.srcPackageDir, 'utf-8');
-    let dependencies;
-    try {
-      dependencies = JSON.parse(packageJson).dependencies;
-    } catch (e) {
-      fail(`解析${packageJson}报错，请检查是否是正确的json配置项`);
-      process.exit(1);
-    }
-    const dependenciesKeys = Object.keys(dependencies);
-    for (const key of dependenciesKeys) {
-      const depPath = path.join(item.destNpmDir, key);
-      if (!fs.existsSync(depPath)) {
-        return true;
-      }
-      const depPackagePath = path.join(depPath, 'package.json');
-      if (fs.existsSync(depPackagePath)) {
-        const packageData = require(depPackagePath);
-        if (dependencies[key] === 'latest') {
-          dependencies[key]  = getLatestVersion(key);
-        }
-        if (packageData.version === 'latest') {
-          packageData.version = getLatestVersion(key);
-        }
-        if (semver.lt(packageData.version, semver.minVersion(dependencies[key]).version)) {
-          return true;
-        }
-      }
-    }
-  }
-  return false;
-};
-
-module.exports = {
-  checkDependencies,
-};
+const fs = require('fs');
+const semver = require('semver');
+const { resolve } = require('./widgets');
+const path = require('path');
+const shelljs = require('shelljs');
+const { handleError } = require('./handleError');
+
+const getLatestVersion = (npmName) => {
+  const data = shelljs.exec(`npm view ${npmName} version`);
+  return data.stdout || '0.0.0';
+};
+
+/**
+ * 检查package.json的依赖大于node_module的版本，则返回true
+ * @param {*} modules 模块
+ * @param {*} cwd  待检查package.json所在的目录 (eg: 当前执行脚本的目录)
+ * @param {*} outputDir  待检查node_modules存放的目录 （eg: dist/node_modules）
+ * @returns
+ */
+const checkDependencies = (modules, cwd, outputDir, isDev) => {
+  // 步骤1. 收集package.json
+  const packageJsonName = 'package.json';  // 查找文件名
+  // 1.1根目录的package.json
+  const packageArr = [
+    {
+      srcPackageDir: path.join(cwd, packageJsonName),
+      destNpmDir: resolve(outputDir, 'node_modules'),
+    },
+  ];
+  // 1.2模块的package.json
+  modules.forEach((item) => {
+    const srcPackageDir = path.join(cwd, item.path, 'package.json');
+    if (fs.existsSync(srcPackageDir)) {
+      packageArr.push({
+        srcPackageDir,
+        destNpmDir: resolve(outputDir, item.root, 'node_modules'),
+      });
+    }
+  });
+
+  // 步骤2. 比较package.json的依赖与node_modules依赖的版本号
+  for (const item of packageArr) {
+    const packageJson = fs.readFileSync(item.srcPackageDir, 'utf-8');
+    let dependencies = {};
+    try {
+      const json = JSON.parse(packageJson);
+      dependencies = json?.dependencies ? json?.dependencies : {};
+    } catch (e) {
+      handleError(`解析${item.srcPackageDir}报错，请检查是否是正确的json配置项`, isDev);
+    }
+    const dependenciesKeys = Object.keys(dependencies);
+    for (const key of dependenciesKeys) {
+      const depPath = path.join(item.destNpmDir, key);
+      if (!fs.existsSync(depPath)) {
+        return true;
+      }
+      const depPackagePath = path.join(depPath, 'package.json');
+      if (fs.existsSync(depPackagePath)) {
+        const packageData = require(depPackagePath);
+        if (dependencies[key] === 'latest') {
+          dependencies[key]  = getLatestVersion(key);
+        }
+        if (packageData.version === 'latest') {
+          packageData.version = getLatestVersion(key);
+        }
+        if (semver.lt(packageData.version, semver.minVersion(dependencies[key]).version)) {
+          return true;
+        }
+      }
+    }
+  }
+  return false;
+};
+
+module.exports = {
+  checkDependencies,
+};

package/src/utils/cliUtils.js

@@ -1,35 +1,35 @@
-const fs = require('fs');
-const cp = require('child_process');
-
-const getDevtoolCliPath = async () => {
-  let cliPath;
-  if (process.platform === 'darwin') {
-    cliPath = '/Applications/wechatwebdevtools.app/Contents/MacOS/cli';
-  } else if (process.platform === 'win32') {
-    cliPath = 'C:/Program Files (x86)/Tencent/微信web开发者工具/cli.bat';
-  } else {
-    // 其余平台暂不支持
-    throw new Error('unsupported platform');
-  }
-  const exists = await new Promise(resolve => fs.exists(cliPath, resolve));
-  if (!exists) {
-    // 找不到开发工具
-    throw new Error(`未找到微信小程序开发者工具，请确认是否安装，如未安装请前往 
-    https://developers.weixin.qq.com/miniprogram/dev/devtools/download.html 下载`);
-  }
-  return cliPath;
-};
-
-const openDevtool = async (path) => {
-  const cliPath = await getDevtoolCliPath();
-  const child = cp.spawn(cliPath, ['open', '--project', path], {
-    detached: true,
-    stdio: 'inherit',
-  });
-  child.unref();
-};
-
-module.exports = {
-  getDevtoolCliPath,
-  openDevtool,
-};
+const fs = require('fs');
+const cp = require('child_process');
+
+const getDevtoolCliPath = async () => {
+  let cliPath;
+  if (process.platform === 'darwin') {
+    cliPath = '/Applications/wechatwebdevtools.app/Contents/MacOS/cli';
+  } else if (process.platform === 'win32') {
+    cliPath = 'C:/Program Files (x86)/Tencent/微信web开发者工具/cli.bat';
+  } else {
+    // 其余平台暂不支持
+    throw new Error('unsupported platform');
+  }
+  const exists = await new Promise(resolve => fs.exists(cliPath, resolve));
+  if (!exists) {
+    // 找不到开发工具
+    throw new Error(`未找到微信小程序开发者工具，请确认是否安装，如未安装请前往 
+    https://developers.weixin.qq.com/miniprogram/dev/devtools/download.html 下载`);
+  }
+  return cliPath;
+};
+
+const openDevtool = async (path) => {
+  const cliPath = await getDevtoolCliPath();
+  const child = cp.spawn(cliPath, ['open', '--project', path], {
+    detached: true,
+    stdio: 'inherit',
+  });
+  child.unref();
+};
+
+module.exports = {
+  getDevtoolCliPath,
+  openDevtool,
+};