@tmsfe/tmskit 0.0.19 → 0.0.20

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tmsfe/tmskit",
-  "version": "0.0.19",
+  "version": "0.0.20",
   "description": "tmskit",
   "main": "dist/index.cjs",
   "bin": {
@@ -41,21 +41,16 @@
   "dependencies": {
     "ansi-colors": "1.1.0",
     "anymatch": "^1.3.0",
-    "fancy-log": "1.3.2",
-    "glob-parent": "^3.0.1",
-    "path-is-absolute": "^1.0.1",
-    "readable-stream": "^2.2.2",
-    "slash": "^1.0.0",
-    "vinyl": "^2.1.0",
-    "vinyl-file": "^2.0.0",
     "async": "^3.2.2",
     "chalk": "^4.1.0",
     "chokidar": "^3.5.3",
     "commander": "^8.3.0",
     "copy-webpack-plugin": "^9.1.0",
     "ejs": "^3.1.5",
+    "fancy-log": "1.3.2",
     "fs-extra": "^10.0.1",
     "glob-ignore": "^1.0.2",
+    "glob-parent": "^3.0.1",
     "gulp": "^4.0.2",
     "gulp-watch": "^5.0.1",
     "htmlparser2": "^7.2.0",
@@ -67,13 +62,20 @@
     "moment": "^2.29.2",
     "object-assign": "^4.0.1",
     "ora": "^5.1.0",
+    "path-is-absolute": "^1.0.1",
     "plugin-error": "^1.0.0",
     "postcss": "^8.4.6",
     "precinct": "^8.3.1",
+    "readable-stream": "^2.2.2",
     "replace-ext": "^2.0.0",
+    "request": "^2.88.2",
     "shelljs": "^0.8.4",
+    "slash": "^1.0.0",
     "strip-comments": "^2.0.1",
     "through2": "^4.0.2",
+    "unzipper": "^0.10.11",
+    "vinyl": "^2.1.0",
+    "vinyl-file": "^2.0.0",
     "vinyl-sourcemaps-apply": "^0.2.0"
   },
   "engines": {

package/src/compile/build.js

@@ -1,5 +1,5 @@
 const dev = require('./dev');
 
-module.exports = async (tmsConfig, newModules) => {
-  dev(tmsConfig, newModules, false);
+module.exports = async (tmsConfig, newModules, subPackages, isDev) => {
+  dev(tmsConfig, newModules, subPackages, isDev);
 };

package/src/compile/dev.js

@@ -30,21 +30,19 @@ function excludeGlob(glob) {
   return Array.from(otherArr);
 }
 
-function adaptPath(pathDir) {
+function adaptPath(pathDir, cwd = '') {
   let newPath = pathDir;
-  newPath = newPath.startsWith('/') ? newPath : resolve(newPath);
+  newPath = newPath.startsWith('/') ? newPath : resolve(cwd, newPath);
   newPath = newPath.endsWith('/') ? newPath.slice(0, newPath.length - 1) : newPath;
   return newPath;
 }
-module.exports = async (tmsConfig, newModules, isDev = true) => {
+module.exports = async (tmsConfig, modules, subPackages, isDev = true) => {
   const compileTasksMap = new Map();
 
   // 监听根目录的文件
   mergeMap(compileTasksMap, compile(tmsConfig, {
     glob: {
       json: DEFAULT_COPY_CONFIG.map(item => resolve(item)),
-      // wxss: ['app.less', 'app.wxss'].map(item => resolve(item)),
-      // js: ['app.js', 'app.ts'].map(item => resolve(item)),
     },
     module: { from: resolve(), to: resolve(tmsConfig.outputDir) },
     destPath: resolve(tmsConfig.outputDir),
@@ -53,40 +51,47 @@ module.exports = async (tmsConfig, newModules, isDev = true) => {
   }));
 
   // 监听模块的文件
-  for (let module of newModules) {
+  for (let pkg of subPackages) {
     // 处理默认参数
-    module = {
+    pkg = {
       ...{ exclude: [] },
-      ...module,
+      ...pkg,
     };
-    const modulePath = adaptPath(module.path);
+    const packagePath = adaptPath(pkg.path);
 
     if (isDev) {
       // 监听模块配置文件
       watch(
-        [`${modulePath}/**/module.config.json`],
+        [`${packagePath}/**/module.config.json`],
         { events: watchEvents },
-        () => buildOutputAppJson(tmsConfig, newModules, isDev),
-        { from: modulePath, to: modulePath },
+        () => buildOutputAppJson(tmsConfig, modules, isDev),
+        { from: packagePath, to: packagePath },
       );
     }
 
-    const excludes = module.exclude.map(key => `!${resolve(key)}`);
+    const excludes = pkg.exclude.map((ePath) => {
+      const newPath = adaptPath(ePath, packagePath);
+      const ext = path.extname(ePath).slice(1);
+      if (ext)  {
+        return `!${resolve(packagePath, newPath)}`;
+      }
+      return `!${resolve(packagePath, newPath)}/**/*`;
+    });
     const glob = {
-      js: [`${modulePath}/**/*.{js,ts,wxs}`, ...excludes],
-      json: [`${modulePath}/**/*.json`, `!${modulePath}/**/module.config.json`, ...excludes],
-      wxss: [`${modulePath}/**/*.{less,wxss}`, ...excludes],
-      wxml: [`${modulePath}/**/*.wxml`, ...excludes],
-      image: [`${modulePath}/**/*.{png,jpg,jpeg,gif,svg}`, ...excludes],
+      js: [`${packagePath}/**/*.{js,ts,wxs}`, ...excludes],
+      json: [`${packagePath}/**/*.json`, `!${packagePath}/**/module.config.json`, ...excludes],
+      wxss: [`${packagePath}/**/*.{less,wxss,scss,sass,styl}`, ...excludes],
+      wxml: [`${packagePath}/**/*.wxml`, ...excludes],
+      image: [`${packagePath}/**/*.{png,jpg,jpeg,gif,svg}`, ...excludes],
     };
 
     mergeMap(compileTasksMap, compile(tmsConfig, {
       glob: {
         ...glob,
-        other: [`${modulePath}/**/*`, ...excludeGlob(glob)],
+        other: [`${packagePath}/**/*`, ...excludeGlob(glob)],
       },
-      destPath: resolve(tmsConfig.outputDir, module.root),
-      module: { from: module.path, to: module.root },
+      destPath: resolve(tmsConfig.outputDir, pkg.root),
+      module: { from: pkg.path, to: pkg.root },
       srcOption: { allowEmpty: true },
       isDev,
     }));
@@ -106,7 +111,7 @@ module.exports = async (tmsConfig, newModules, isDev = true) => {
         glob = {
           js: [`${item.from}/**/*.{js,ts,wxs}`],
           json: [`${item.from}/**/*.json`],
-          wxss: [`${item.from}/**/*.{less,wxss}`],
+          wxss: [`${item.from}/**/*.{less,wxss,scss,sass,styl}`],
           wxml: [`${item.from}/**/*.wxml`],
           image: [`${item.from}/**/*.{png,jpg,jpeg,gif,svg}`],
         };
@@ -142,7 +147,7 @@ module.exports = async (tmsConfig, newModules, isDev = true) => {
       watch(
         [resolve('app.json')],
         { ignoreInitial: false, events: watchEvents },
-        () => buildOutputAppJson(tmsConfig, newModules, isDev),
+        () => buildOutputAppJson(tmsConfig, modules, isDev),
         { from: resolve(), to: resolve(tmsConfig.outputDir) },
       );
       // 监听其他文件
@@ -150,14 +155,14 @@ module.exports = async (tmsConfig, newModules, isDev = true) => {
         watch(globValue, { ignoreInitial: true, events: watchEvents }, taskFn, module);
       });
     } else {
-      buildOutputAppJson(tmsConfig, newModules, isDev);
+      buildOutputAppJson(tmsConfig, modules, isDev);
     }
     eTime = new Date().getTime() - sTime;
     if (typeof tmsConfig?.hooks?.afterCompile === 'function') {
       await tmsConfig?.hooks?.afterCompile({
         isDev,
         tmsConfig: filterField(tmsConfig, ['gitAccount']),
-        modules: newModules,
+        modules,
       });
     }
     spinner.succeed(chalk.green(`首次编译完成, 耗时${eTime / 1000}s, 微信开发者工具打开项目即可预览。`));

package/src/compile/watch.js

@@ -1,25 +1,44 @@
+/* eslint-disable no-restricted-syntax */
 const watch = require('./plugins/gulp-watch');
 const path = require('path');
 const shellJs = require('shelljs');
-const { info, warn } = require('../utils/log');
+const { info, warn, fail } = require('../utils/log');
 const { resolve } = require('../utils/widgets');
 const { global } = require('../utils/global');
+const { checkPackageVersion } = require('../core/checkDependencies');
 const { findAllFilesOfDir } = require('../utils/io');
 
 const TIP_MAP = {
-  'package.json': '若依赖有变动，请重新执行tmskit run dev',
-  'module.config.json': '若dependencies字段有变动，需要重新执行tmskit run dev才会生效',
+  'package.json': {
+    tip: '依赖版本有变动，请重新执行tmskit run dev',
+    check: (sourceFile, targetFile) => {
+      const targetArr = targetFile.split('/');
+      targetArr[targetArr.length - 1] = 'node_modules';
+      const packageArr = [{
+        srcPackageDir: sourceFile,
+        destNpmDir: targetArr.join('/'),
+      }];
+      return checkPackageVersion(packageArr);
+    },
+  },
+  'module.config.json': {
+    tip: '若dependencies字段有变动，请重新执行tmskit run dev才会生效',
+    check: () => true,
+  },
 };
 
-const logTip = (fileName, tipMap) => {
-  // eslint-disable-next-line
-  for (const item in tipMap) {
-    if (fileName.indexOf(item) > -1) {
-      warn(`${fileName}有更新, ${tipMap[item]}`);
-      return;
+const logTip = (fileName, sourceFile, targetFile, tipMap) => {
+  try {
+    for (const item in tipMap) {
+      if (fileName.indexOf(item) > -1 && tipMap[item].check(sourceFile, targetFile)) {
+        warn(`${fileName}有更新, ${tipMap[item].tip}`);
+        return;
+      }
     }
+    info(`${fileName}有更新`);
+  } catch (e) {
+    fail(`${sourceFile}文件更新提示出现错误:  ${e.message}`);
   }
-  info(`${fileName}有更新`);
 };
 
 const getTargetFile = (sourceFile, module, outputDir) => {
@@ -46,7 +65,7 @@ module.exports = function (globValue, watchOptions, callback, module) {
         const fileDirArr = file.replace(/\\/g, '/').split('/');
         const fileName = fileDirArr.slice(fileDirArr.length - 2).join('/');
         const targetFile = getTargetFile(file, module, tmsConfig.outputDir);
-        logTip(fileName, TIP_MAP);
+        logTip(fileName, sourceFile, targetFile, TIP_MAP);
         callback([file], path.dirname(targetFile));
       }
       return;
@@ -59,7 +78,7 @@ module.exports = function (globValue, watchOptions, callback, module) {
       return;
     }
 
-    logTip(sourceFileName, TIP_MAP);
+    logTip(sourceFileName, sourceFile, targetFile, TIP_MAP);
     return callback([sourceFile], path.dirname(targetFile));
   });
 };

package/src/config/constant.js

@@ -13,11 +13,15 @@ const  CACHE_FILE = 'cache_file.json';
 // 脚手架模板代码所在目录
 const TEMPLATE_DIR = path.resolve(CACHE_DIR, 'template');
 
+// 模板的名称
+const TEMPLATE_NAME = 'tmskit-template';
+
 // 第三方模块源码存放的临时缓存目录
 const MODULE_CODE_DIR = path.resolve(CACHE_DIR, 'modules_code');
 
-// 脚手架模板代码的具体路径
-const TEMPLATE_PATH = path.resolve(TEMPLATE_DIR, 'tools/tmskit-template');
+
+// 脚手架模板的远程地址
+const TEMPLATE_URL = 'https://tms-web-1g1czzwka2fd06f2-1301126013.tcloudbaseapp.com/tmskit-template/tmskit-template.zip';
 
 // 脚手架的名称
 const TMS_NAME = 'tmskit';
@@ -51,13 +55,28 @@ const ENV = {
 
 const  TEMPLATE_TKIT_DIR = '_tmskit';
 
+const  CREATE_TEMPLATE_QUESTION = [
+  {
+    type: 'list',
+    name: 'projectType',
+    message: '选择你要创建的模板',
+    choices: [{
+      name: '小程序项目',
+      value: 'mp',
+    }, {
+      name: '小程序模块',
+      value: 'mp-module',
+    }],
+  },
+];
+
 
 export {
   HOME_DIR,
   CACHE_DIR,
   CACHE_FILE,
   TEMPLATE_DIR,
-  TEMPLATE_PATH,
+  TEMPLATE_NAME,
   TMS_NAME,
   TMS_CONFIG_FILENAME,
   TMS_PRIVATE_FILENAME,
@@ -69,4 +88,6 @@ export {
   ENV,
   TEMPLATE_TKIT_DIR,
   DEFAULT_CLOUD_MODULE_DIR,
+  CREATE_TEMPLATE_QUESTION,
+  TEMPLATE_URL,
 };

package/src/core/buildAppJson.js

@@ -3,10 +3,9 @@
  */
 /* eslint-disable no-param-reassign */
 const fs = require('fs');
-const { MODULE_CONFIG_FILENAME } = require('../config/constant');
-const { getModuleConfig } = require('./tmsMpconfig');
-const { fail } = require('../utils/log');
-const { resolve, isObject, filterField } = require('../utils/widgets');
+const { getSubPackages, getModulesConfig } = require('./tmsMpconfig');
+const { fail, info } = require('../utils/log');
+const { resolve, filterField } = require('../utils/widgets');
 const { handleError } = require('./handleError');
 const { global } = require('../utils/global');
 
@@ -58,19 +57,7 @@ const getAppJsonContent = (sourceAppJsonPath) => {
   appJson.pages = [];
   return appJson;
 };
-/**
- * 更新app.json中的subpackages
- * @param {Object} appJson
- * @param {Object} modulesConfigs
- */
-const updateSubpackages = (appJson, modulesConfigs) => {
-  // eslint-disable-next-line
-  for (const modulePath in modulesConfigs) {
-    const moduleInfo = isObject(modulesConfigs[modulePath]) ? [modulesConfigs[modulePath]] : modulesConfigs[modulePath];
-    appJson.subpackages = appJson.subpackages.concat(moduleInfo);
-  }
-  appJson.subpackages.sort((item1, item2) => item1.name.localeCompare(item2.name));
-};
+
 
 /**
  * 处理合并subpackages后的appjson, 整理重复不合法的地方
@@ -109,7 +96,7 @@ const fixAppJson = (appJson) => {
         appJson[key] = preloadRuleMap;
       }
     });
-    return filterField(subp, [...arrOfFileType, ...objOfFileType, 'dependencies']);
+    return filterField(subp, [...arrOfFileType, ...objOfFileType, 'dependencies', 'path']);
   });
   // 如果plugins重复，则错误提示
   const pluginsErrMsg = Object.keys(pluginsMap).map((pk) => {
@@ -133,12 +120,17 @@ const fixAppJson = (appJson) => {
  */
 function buildOutputAppJson(tmsConfig, modules) {
   try {
-    // 获取当前 modules 下的所有子模块的配置内容
-    const modulesConfigs = getModuleConfig(modules, tmsConfig.appName, MODULE_CONFIG_FILENAME);
+    // 获取所有模块，合并模块依赖的模块
+    const modulesConfig = getModulesConfig(modules, tmsConfig.appName, false);
+    // 获取所有的分包
+    const subPackages = getSubPackages(modulesConfig);
     // 获取app.json的配置
     const appJson = getAppJsonContent(resolve('./app.json'));
+
     // 更新app.json中的subpackages
-    updateSubpackages(appJson, modulesConfigs);
+    appJson.subpackages = subPackages;
+    appJson.subpackages.sort((item1, item2) => item1.name.localeCompare(item2.name));
+
     // 处理appJson中重复||冲突的地方
     fixAppJson(appJson);
     // 更新主包，需在subpackages处理完成后执行， pages/
@@ -157,6 +149,7 @@ function buildOutputAppJson(tmsConfig, modules) {
     return appJson;
   } catch (e) {
     handleError(`生成app.json出现错误: ${e}`);
+    info(e);
   }
 }
 

package/src/core/checkDependencies.js

@@ -10,15 +10,8 @@ const getLatestVersion = (npmName) => {
   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 isDependenciesUpdate = (modules, cwd, outputDir) => {
-  // 步骤1. 收集package.json
+// 收集package.json
+function collectHasPackageJson(modules, cwd, outputDir) {
   const packageJsonName = 'package.json';  // 查找文件名
   // 1.1根目录的package.json
   const packageArr = [
@@ -37,17 +30,40 @@ const isDependenciesUpdate = (modules, cwd, outputDir) => {
       });
     }
   });
+  return packageArr;
+}
 
+// 读取package.json的依赖
+function readPackageDependencies(srcPackageDir) {
+  const packageJson = fs.readFileSync(srcPackageDir, 'utf-8');
+  let dependencies = {};
+  try {
+    const json = packageJson ? JSON.parse(packageJson) : {};
+    dependencies = json?.dependencies || {};
+  } catch (e) {
+    handleError(`解析${srcPackageDir}报错，请检查是否是正确的json配置项 ${e}`);
+  }
+  return dependencies;
+}
+
+/**
+ * 检查package.json的依赖大于node_module的版本，则返回true
+ * @param {*} modules 模块
+ * @param {*} cwd  待检查package.json所在的目录 (eg: 当前执行脚本的目录)
+ * @param {*} outputDir  待检查node_modules存放的目录 （eg: dist/node_modules）
+ * @returns
+ */
+const isDependenciesUpdate = (modules, cwd, outputDir) => {
+  // 步骤1. 收集package.json
+  const packageArr = collectHasPackageJson(modules, cwd, outputDir);
   // 步骤2. 比较package.json的依赖与node_modules依赖的版本号
+  return checkPackageVersion(packageArr);
+};
+
+// 比较package.json的依赖与node_modules依赖的版本号
+const checkPackageVersion = (packageArr) => {
   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配置项 ${e}`);
-    }
+    const dependencies = readPackageDependencies(item.srcPackageDir);
     const dependenciesKeys = Object.keys(dependencies);
     for (const key of dependenciesKeys) {
       const depPath = path.join(item.destNpmDir, key);
@@ -74,4 +90,5 @@ const isDependenciesUpdate = (modules, cwd, outputDir) => {
 
 module.exports = {
   isDependenciesUpdate,
+  checkPackageVersion,
 };

package/src/core/cloneModules.js

@@ -21,9 +21,7 @@ function replaceGitUrlAccount(httpRepoUrl, moduleName) {
   const tmsConfig = global.getData('tmsConfig');
 
   let gitUrl = httpRepoUrl;
-  const { username = '', pass = '' } = tmsConfig?.gitAccout?.[moduleName]
-    || tmsConfig?.gitAccount?.[moduleName]
-    || {};
+  const { username = '', pass = '' } = tmsConfig?.gitAccount?.[moduleName] || {};
 
   const urlPrefixReg = /http(s)?:\/\//;
   if (username && pass && urlPrefixReg.test(gitUrl)) {
@@ -122,10 +120,10 @@ function collectDownLoadTasksMap(sourceDir, targetDir,  modules) {
   const downloadTasksMap = new Map();
   for (const moduleInfo of modules) {
     if (moduleInfo.repoInfo) {
-      const { repoInfo: { buildGitTag: branch, httpRepoUrl, path: gitPath = '' }, path, name } = moduleInfo;
+      const { repoInfo: { buildGitTag: branch, httpRepoUrl, path: gitPath = '' }, path, moduleName } = moduleInfo;
 
       // 处理仓库权限问题
-      const gitUrl = replaceGitUrlAccount(httpRepoUrl, name);
+      const gitUrl = replaceGitUrlAccount(httpRepoUrl, moduleName);
       // 根据gitUrl与branch计算md5
       const md5Key = md5ByGitUrlBranch(gitUrl, branch);
       // git源码临时存在的源目录
@@ -191,8 +189,8 @@ function collectDownLoadTasksMap(sourceDir, targetDir,  modules) {
  */
 function checkRemoteModGitUrlBranch(sourceDir, moduleInfo) {
   if (moduleInfo.repoInfo) {
-    const { repoInfo: { buildGitTag, httpRepoUrl }, name } = moduleInfo;
-    const gitUrl = replaceGitUrlAccount(httpRepoUrl, name);
+    const { repoInfo: { buildGitTag, httpRepoUrl }, moduleName } = moduleInfo;
+    const gitUrl = replaceGitUrlAccount(httpRepoUrl, moduleName);
     const md5Key = md5ByGitUrlBranch(gitUrl, buildGitTag);
     if (!fs.existsSync(`${sourceDir}/${md5Key}`)) {
       return true;

package/src/core/handleError.js

@@ -1,8 +1,14 @@
 const { fail } = require('../utils/log');
 const { global } = require('../utils/global');
 
-function handleError(error) {
+function handleError(error, isQuit = false) {
   const errMsg = typeof error === 'object' ? error.message : error;
+
+  if (isQuit) {
+    fail(errMsg);
+    process.exit(1);
+  }
+
   const isDev = global.getData('isDev');
   if (isDev) {
     fail(errMsg);

package/src/core/npm.js

@@ -30,7 +30,12 @@ const collectNpmTasksMap = (packageJsonFiles, cacheDir) => {
   const npmTasksMap = new Map();
   for (const packageJsonPath of packageJsonFiles) {
     const packageContent = fs.readFileSync(packageJsonPath);
-    const packageJson = JSON.parse(packageContent);
+    let packageJson;
+    try {
+      packageJson = JSON.parse(packageContent);
+    } catch (e) {
+      throw new Error(`${packageJsonPath}json解析出现错误:${e}`);
+    }
     const md5Obj = {
       dependencies: packageJson.dependencies || {},
     };
@@ -118,7 +123,7 @@ const npmInstallAll = async (modules, contextDir, cacheDir) => {
         return Promise.all(callArr);
       })
       .catch((e) => {
-        handleError(`npm install ${params.packageJsonPath}出现错误：${e}`);
+        handleError(`npm install ${params.packageJsonPath}出现错误：${e}`, true);
       }));
   });