@tmsfe/tmskit 0.0.19 → 0.0.22

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tmsfe/tmskit",
-  "version": "0.0.19",
+  "version": "0.0.22",
   "description": "tmskit",
   "main": "dist/index.cjs",
   "bin": {
@@ -30,50 +30,49 @@
   "devDependencies": {
     "@rollup/plugin-babel": "^5.0.2",
     "@rollup/plugin-commonjs": "^19.0.0",
-    "@rollup/plugin-dynamic-import-vars": "^1.1.1",
     "@rollup/plugin-json": "^4.0.3",
-    "rollup": "^2.6.1",
-    "rollup-plugin-node-resolve": "^5.2.0",
-    "rollup-plugin-replace": "^2.2.0",
-    "rollup-plugin-terser": "^6.1.0",
-    "rollup-plugin-typescript2": "0.27.0"
+    "rollup": "^2.6.1"
   },
   "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-if": "^3.0.0",
     "gulp-watch": "^5.0.1",
     "htmlparser2": "^7.2.0",
     "inquirer": "^7.3.3",
     "leven": "3.1.0",
     "lodash": "^4.17.21",
     "metalsmith": "^2.3.0",
+    "minimatch": "^5.1.0",
     "miniprogram-ci": "1.4.13",
     "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/{init.js → check.js}

@@ -22,12 +22,11 @@ const checkNodeVersion = (wanted, id) => {
 
 /**
  * 检查运行环境
- * @returns {Undefined} 无需返回值
  */
-function initCliContext() {
+function check() {
   // 执行操作前检查node版本
   // 旧版本node直接提示升级，退出脚本
   checkNodeVersion(requiredVersion, packName);
 }
 
-module.exports = initCliContext;
+module.exports = check;

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, isDev) => {
+  dev(tmsConfig, newModules, isDev);
 };

package/src/compile/compile.js

@@ -1,16 +1,41 @@
 const { src, dest } = require('gulp');
-// const px2rpx = require('gulp-px-to-rpx');
-// const cache = require('gulp-cache');
-// const image = require('gulp-image');
-// const replaceEnv = require('./plugins/replaceEnv');
-const { mpCommonDep } = require('./plugins/mpCommonDep');
-const { mpJsonDep } = require('./plugins/mpJsonDep');
-const { mpWxmlDep } = require('./plugins/mpWxmlDep');
-// const postcss = require('gulp-postcss');
-// const base64 = require('./plugins/postcss-font-base64');
+const path = require('path');
+const minimatch = require('minimatch');
+const gulpif = require('gulp-if');
+const mpProjectJson = require('./plugins/mpProjectJson');
+const { resolve } = require('../utils/widgets');
+const through = require('through2');
 const { fail } = require('../utils/log');
 
-// const since = task => file => (lastRun(task) > file.stat.ctime ? lastRun(task) : 0);
+const getTargetFile = (sourceFile, module, outputDir) => {
+  const sourceFileRelativeModule = path.relative(resolve(module.from), sourceFile);
+  const targetFile = resolve(outputDir, module.to, sourceFileRelativeModule);
+  return targetFile;
+};
+
+const addPlugins =  function (tmsConfig, srcPipe, pluginParams) {
+  const { plugins = [] } = tmsConfig;
+  const newPlugins = [{
+    glob: '**/project.config.json',
+    action: mpProjectJson(),
+  }, ...plugins];
+  return newPlugins.reduce((srcPipe, pluginItem) => srcPipe.pipe(gulpif(
+    file => minimatch(file.path, pluginItem.glob),
+    through.obj(function (file, enc, cb) {
+      const sourceFile = file.history[0];
+      pluginItem.action({
+        tmsConfig,
+        sourceFile,
+        file,
+        targetFile: getTargetFile(sourceFile, pluginParams.module, tmsConfig.outputDir),
+        isDev: pluginParams.isDev,
+        cb,
+      });
+      this.push(file);
+    }),
+  )), srcPipe);
+};
+
 module.exports = function (
   tmsConfig,
   {
@@ -22,150 +47,23 @@ module.exports = function (
   },
 ) {
   const compileTasksMap = new Map();
-  Object.keys(glob).forEach((globKey) => {
-    const globValue = glob[globKey];
-
-    switch (globKey) {
-      case 'js':
-        compileTasksMap.set(
-          globValue,
-          {
-            module,
-            taskFn: (sourceFile, targetPath) => {
-              const newGlobValue = Array.isArray(sourceFile) ? sourceFile : globValue;
-              const newDestPath = targetPath ? targetPath : destPath;
-              const srcPipe = src(newGlobValue, { ...srcOption });
-              return srcPipe
-                // .pipe(replaceEnv(/process\.env(\.(\w*))?/g, tmsConfig.envData))
-                .pipe(mpCommonDep(tmsConfig, module, ['.js', '.ts', '.wxs', '.json'], isDev))
-                .on('error', (err) => {
-                  fail(`mpCommonDep编译报错${err}`);
-                })
-                .pipe(dest(newDestPath, { overwrite: true }))
-                .on('error', (err) => {
-                  fail(`js编译报错${err}`);
-                });
-            },
-          },
-        );
-        break;
-      case 'wxss':
-        compileTasksMap.set(
-          globValue,
-          {
-            module,
-            taskFn: (sourceFile, targetPath) => {
-              const newGlobValue = Array.isArray(sourceFile) ? sourceFile : globValue;
-              const newDestPath = targetPath ? targetPath : destPath;
-              const srcPipe = src(newGlobValue, { ...srcOption });
-              return srcPipe
-                .pipe(mpCommonDep(tmsConfig, module, ['.wxss', '.less'], isDev))
-                .on('error', (err) => {
-                  fail(`mpCommonDep编译报错${err}`);
-                })
-                // .pipe(postcss([base64()]))
-                // .on('error', (err) => {
-                //   fail(`postcss编译报错${err}`);
-                // })
-                // .pipe(px2rpx({
-                //   designWidth: 375, // 设计稿宽度，默认为750
-                //   precision: 2, // 小数最大精度，默认为6
-                // }))
-                .pipe(dest(newDestPath))
-                .on('error', (err) => {
-                  fail(`wxss编译报错${err}`);
-                });
-            },
-          },
-        );
-        break;
-      case 'json':
-        compileTasksMap.set(
-          globValue,
-          {
-            module,
-            taskFn: (sourceFile, targetPath) => {
-              const newGlobValue = Array.isArray(sourceFile) ? sourceFile : globValue;
-              const newDestPath = targetPath ? targetPath : destPath;
-              const srcPipe = src(newGlobValue, { ...srcOption });
-              return srcPipe
-                .pipe(mpJsonDep(tmsConfig, module, ['.json'], ['.wxml', '.json', '.js', '.ts', '.wxss', '.less'], isDev))
-                .on('error', (err) => {
-                  fail(`mpJsonDep编译报错${err}`);
-                })
-                .pipe(dest(newDestPath))
-                .on('error', (err) => {
-                  fail(`json编译报错${err}`);
-                });
-            },
-          },
-        );
-        break;
-      case 'wxml':
-        compileTasksMap.set(
-          globValue,
-          {
-            module,
-            taskFn: (sourceFile, targetPath) => {
-              const newGlobValue = Array.isArray(sourceFile) ? sourceFile : globValue;
-              const newDestPath = targetPath ? targetPath : destPath;
-              const srcPipe = src(newGlobValue, { ...srcOption });
-              return srcPipe
-                .pipe(mpWxmlDep(tmsConfig, module, isDev))
-                .on('error', (err) => {
-                  fail(`mpWxmlDep编译报错${err}`);
-                })
-                .pipe(dest(newDestPath))
-                .on('error', (err) => {
-                  fail(`wxml编译报错${err}`);
-                });
-            },
-          },
-        );
-        break;
-      case 'image':
-        compileTasksMap.set(
-          globValue,
-          {
-            module,
-            taskFn: (sourceFile, targetPath) => {
-              const newGlobValue = Array.isArray(sourceFile) ? sourceFile : globValue;
-              const newDestPath = targetPath ? targetPath : destPath;
-              const srcPipe = src(newGlobValue, { ...srcOption });
-              return srcPipe
-              // .pipe(cache(image()))
-              // .on('error', (err) => {
-              //   fail(`image编译报错${err}`);
-              // })
-                .pipe(dest(newDestPath))
-                .on('error', (err) => {
-                  fail(`image编译报错${err}`);
-                });
-            },
-          },
-        );
-        break;
-      case 'other':
-        compileTasksMap.set(
-          globValue,
-          {
-            module,
-            taskFn: (sourceFile, targetPath) => {
-              const newGlobValue = Array.isArray(sourceFile) ? sourceFile : globValue;
-              const newDestPath = targetPath ? targetPath : destPath;
-              const srcPipe = src(newGlobValue, { ...srcOption });
-              return srcPipe
-                .pipe(dest(newDestPath))
-                .on('error', (err) => {
-                  fail(`编译报错${err}`);
-                });
-            },
-          },
-        );
-        break;
-      default:
-        break;
-    }
-  });
+  compileTasksMap.set(
+    glob,
+    {
+      module,
+      taskFn: (sourceFile, targetPath) => {
+        const newGlobValue = Array.isArray(sourceFile) ? sourceFile : glob;
+        const newDestPath = targetPath ? targetPath : destPath;
+        let srcPipe = src(newGlobValue, { ...srcOption });
+        const pluginParams = { module, isDev };
+        srcPipe = addPlugins(tmsConfig, srcPipe, pluginParams);
+        return srcPipe
+          .pipe(dest(newDestPath))
+          .on('error', (err) => {
+            fail(`编译报错${err}`);
+          });
+      },
+    },
+  );
   return compileTasksMap;
 };

package/src/compile/dev.js

@@ -3,124 +3,84 @@ const fs = require('fs');
 const ora = require('ora');
 const chalk = require('chalk');
 const { parallel, series } = require('gulp');
-const { resolve, mergeMap, filterField } = require('../utils/widgets');
+const { resolve, mergeMap, filterField, getAbsolutePath } = require('../utils/widgets');
 const { buildOutputAppJson } = require('../core/buildAppJson');
 const { DEFAULT_COPY_CONFIG } = require('../config/constant');
 const compile = require('./compile');
 const watch = require('./watch');
 const { info } = require('../utils/log');
+const report = require('../core/report');
 
 const watchEvents = ['add', 'change', 'unlink', 'addDir', 'unlinkDir'];
-function excludeGlob(glob) {
-  const otherArr = new Set();
-  otherArr.add('!**/*.{ttf,otf,woff,eot}');
-  Object.keys(glob).forEach((globKey) => {
-    if (typeof glob[globKey] === 'string') {
-      const data = glob[globKey].startsWith('!') ? glob[globKey] : `!${glob[globKey]}`;
-      otherArr.add(data);
-    } if (Array.isArray(glob[globKey])) {
-      glob[globKey].forEach((value) => {
-        if (typeof value === 'string') {
-          const data = value.startsWith('!') ? value : `!${value}`;
-          otherArr.add(data);
-        }
-      });
-    }
-  });
-  return Array.from(otherArr);
-}
 
-function adaptPath(pathDir) {
-  let newPath = pathDir;
-  newPath = newPath.startsWith('/') ? newPath : resolve(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, 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)),
-    },
+    glob: DEFAULT_COPY_CONFIG.map(item => resolve(item)),
     module: { from: resolve(), to: resolve(tmsConfig.outputDir) },
     destPath: resolve(tmsConfig.outputDir),
     srcOption: { allowEmpty: true },
     isDev,
   }));
-
   // 监听模块的文件
-  for (let module of newModules) {
+  for (let moduleItem of modules) {
     // 处理默认参数
-    module = {
+    moduleItem = {
       ...{ exclude: [] },
-      ...module,
+      ...moduleItem,
     };
-    const modulePath = adaptPath(module.path);
+    const srcModulePath = getAbsolutePath(moduleItem.path);
+    const buildModulePath = resolve(tmsConfig.outputDir, moduleItem.modulePath);
 
     if (isDev) {
       // 监听模块配置文件
       watch(
-        [`${modulePath}/**/module.config.json`],
+        [`${srcModulePath}/**/module.config.json`],
         { events: watchEvents },
-        () => buildOutputAppJson(tmsConfig, newModules, isDev),
-        { from: modulePath, to: modulePath },
+        () => buildOutputAppJson(tmsConfig, modules, isDev),
+        { from: srcModulePath, to: buildModulePath },
       );
     }
 
-    const excludes = module.exclude.map(key => `!${resolve(key)}`);
-    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],
-    };
+    const excludes = moduleItem.exclude.map((ePath) => {
+      const newPath = getAbsolutePath(ePath, srcModulePath);
+      const ext = path.extname(ePath).slice(1);
+      if (ext)  {
+        return `!${resolve(srcModulePath, newPath)}`;
+      }
+      return `!${resolve(srcModulePath, newPath)}/**/*`;
+    });
 
     mergeMap(compileTasksMap, compile(tmsConfig, {
-      glob: {
-        ...glob,
-        other: [`${modulePath}/**/*`, ...excludeGlob(glob)],
-      },
-      destPath: resolve(tmsConfig.outputDir, module.root),
-      module: { from: module.path, to: module.root },
+      glob: [`${srcModulePath}/**/*`, `!${srcModulePath}/**/module.config.json`, ...excludes],
+      destPath: buildModulePath,
+      module: { from: srcModulePath, to: buildModulePath },
       srcOption: { allowEmpty: true },
       isDev,
     }));
   }
 
-  // 静态资源目录-拷贝
+  // static静态资源目录
   if (tmsConfig?.static && tmsConfig?.static.length > 0) {
     for (const item of tmsConfig.static) {
-      item.from = adaptPath(item.from);
-      item.to = adaptPath(item.to);
+      item.from = getAbsolutePath(item.from);
+      item.to = getAbsolutePath(item.to);
 
       let glob = {};
       const ext = path.extname(item.from).slice(1);
       if (ext)  {
-        glob[ext] = [item.from];
+        glob = [item.from];
       } else {
-        glob = {
-          js: [`${item.from}/**/*.{js,ts,wxs}`],
-          json: [`${item.from}/**/*.json`],
-          wxss: [`${item.from}/**/*.{less,wxss}`],
-          wxml: [`${item.from}/**/*.wxml`],
-          image: [`${item.from}/**/*.{png,jpg,jpeg,gif,svg}`],
-        };
-        glob.other = [`${item.from}/**/*`, ...excludeGlob(glob)];
+        glob = [`${item.from}/**/*`];
       }
 
       const from = fs.lstatSync(item.from).isFile() ? path.dirname(item.from) : item.from;
       mergeMap(compileTasksMap, compile(tmsConfig, {
         glob,
         destPath: item.to,
-        module: {
-          from,
-          to: item.to,
-        },
+        module: { from, to: item.to },
         srcOption: { allowEmpty: true },
         isDev,
       }));
@@ -142,7 +102,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,15 +110,16 @@ 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,
       });
+      report('hooks:afterCompile');
     }
     spinner.succeed(chalk.green(`首次编译完成, 耗时${eTime / 1000}s, 微信开发者工具打开项目即可预览。`));
     spinner.stop();

package/src/compile/plugins/mpProjectJson.js

@@ -0,0 +1,13 @@
+/* eslint-disable no-param-reassign */
+function mpProjectJson() {
+  return function ({ file, cb }) {
+    if (file.isBuffer()) {
+      let contents = String(file.contents);
+      contents = contents.replace(/"miniprogramRoot"[^,]+,/g, '');
+      file.contents = Buffer.from(contents);
+    }
+    cb();
+  };
+}
+
+module.exports = mpProjectJson;

package/src/compile/watch.js

@@ -1,25 +1,45 @@
+/* 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 { resolve } = require('../utils/widgets');
+const { series } = require('gulp');
+const { info, warn, fail } = require('../utils/log');
+const { resolve, filterField } = require('../utils/widgets');
 const { global } = require('../utils/global');
-const { findAllFilesOfDir } = require('../utils/io');
+const { checkPackageVersion } = require('../core/checkDependencies');
+const report = require('../core/report');
 
 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) => {
@@ -39,27 +59,58 @@ module.exports = function (globValue, watchOptions, callback, module) {
 
     const tmsConfig = global.getData('tmsConfig');
 
-    if (vinyl.event === 'addDir') {
-      info(`更新${sourceFileName}目录`);
-      const files = findAllFilesOfDir(sourceFile);
-      for (const file of files) {
-        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);
-        callback([file], path.dirname(targetFile));
-      }
-      return;
-    }
-
     const targetFile = getTargetFile(sourceFile, module, tmsConfig.outputDir);
     if (vinyl.event === 'unlink' || vinyl.event === 'unlinkDir') {
       info(`删除${sourceFileName}`);
       shellJs.rm('-rf', targetFile);
+      updateFileHook(tmsConfig, sourceFile, targetFile,  vinyl.event);
       return;
     }
-
-    logTip(sourceFileName, TIP_MAP);
-    return callback([sourceFile], path.dirname(targetFile));
+    runCallback({
+      tmsConfig,
+      sourceFile,
+      targetFile,
+      callback,
+      type: vinyl.event,
+    });
+    logTip(sourceFileName, sourceFile, targetFile, TIP_MAP);
   });
 };
+
+// 开始执行watch 文件的 callback函数
+async function runCallback({
+  tmsConfig,
+  sourceFile,
+  targetFile,
+  callback,
+  type,
+}) {
+  // callbacl.name === taskFn 代表进入gulp编译流程
+  // series为gulp编译串行执行，callback执行完毕后，执行updateFileHooks钩子
+  if (callback.name === 'taskFn') {
+    series(
+      callback.bind(null, [sourceFile],  path.dirname(targetFile)),
+      (cb) => {
+        cb();
+        updateFileHook(tmsConfig, sourceFile, targetFile, type);
+      },
+    )();
+  } else {
+    // 普通的callback函数
+    await callback([sourceFile], path.dirname(targetFile));
+    await updateFileHook(tmsConfig, sourceFile, targetFile, type);
+  }
+}
+
+// 执行源码文件更新的钩子
+async function updateFileHook(tmsConfig, sourceFile, targetFile, type) {
+  if (typeof tmsConfig?.hooks?.updateFile === 'function') {
+    await tmsConfig.hooks.updateFile({
+      tmsConfig: filterField(tmsConfig, ['gitAccount']),
+      sourceFile,
+      targetFile,
+      type,
+    });
+    report('hooks:updateFile');
+  }
+}