@tmsfe/tmskit 0.0.15 → 0.0.18

package/package.json

@@ -1,12 +1,13 @@
 {
   "name": "@tmsfe/tmskit",
-  "version": "0.0.15",
+  "version": "0.0.18",
   "description": "tmskit",
   "main": "dist/index.cjs",
   "bin": {
     "tmskit": "main.js"
   },
   "files": [
+    "build",
     "src",
     "dist",
     "main.js",
@@ -38,8 +39,18 @@
     "rollup-plugin-typescript2": "0.27.0"
   },
   "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",
@@ -53,7 +64,7 @@
     "lodash": "^4.17.21",
     "metalsmith": "^2.3.0",
     "miniprogram-ci": "1.4.13",
-    "moment": "^2.29.1",
+    "moment": "^2.29.2",
     "object-assign": "^4.0.1",
     "ora": "^5.1.0",
     "plugin-error": "^1.0.0",

package/src/compile/compile.js

@@ -18,7 +18,7 @@ module.exports = function (
     destPath,
     srcOption,
     module,
-    isWatch,
+    isDev,
   },
 ) {
   const compileTasksMap = new Map();
@@ -31,14 +31,17 @@ module.exports = function (
           globValue,
           {
             module,
-            taskFn: () => {
-              // const srcTask = () => src(globValue, { ...srcOption, since: since(srcTask) });
-              // const srcPipe = srcTask();
-              const srcPipe = src(globValue, { ...srcOption });
+            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'], isWatch))
-                .pipe(dest(destPath))
+                .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}`);
                 });
@@ -51,12 +54,12 @@ module.exports = function (
           globValue,
           {
             module,
-            taskFn: () => {
-              // const srcTask = () => src(globValue, { ...srcOption, since: since(srcTask) });
-              // const srcPipe = srcTask();
-              const srcPipe = src(globValue, { ...srcOption });
+            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'], isWatch))
+                .pipe(mpCommonDep(tmsConfig, module, ['.wxss', '.less'], isDev))
                 .on('error', (err) => {
                   fail(`mpCommonDep编译报错${err}`);
                 })
@@ -68,7 +71,10 @@ module.exports = function (
                 //   designWidth: 375, // 设计稿宽度，默认为750
                 //   precision: 2, // 小数最大精度，默认为6
                 // }))
-                .pipe(dest(destPath));
+                .pipe(dest(newDestPath))
+                .on('error', (err) => {
+                  fail(`wxss编译报错${err}`);
+                });
             },
           },
         );
@@ -78,16 +84,19 @@ module.exports = function (
           globValue,
           {
             module,
-            taskFn: () => {
-              // const srcTask = () => src(globValue, { ...srcOption, since: since(srcTask) });
-              // const srcPipe = srcTask();
-              const srcPipe = src(globValue, { ...srcOption });
+            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'], isWatch))
+                .pipe(mpJsonDep(tmsConfig, module, ['.json'], ['.wxml', '.json', '.js', '.ts', '.wxss', '.less'], isDev))
                 .on('error', (err) => {
                   fail(`mpJsonDep编译报错${err}`);
                 })
-                .pipe(dest(destPath));
+                .pipe(dest(newDestPath))
+                .on('error', (err) => {
+                  fail(`json编译报错${err}`);
+                });
             },
           },
         );
@@ -97,13 +106,19 @@ module.exports = function (
           globValue,
           {
             module,
-            taskFn: () => {
-              // const srcTask = () => src(globValue, { ...srcOption, since: since(srcTask) });
-              // const srcPipe = srcTask();
-              const srcPipe = src(globValue, { ...srcOption });
+            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, isWatch))
-                .pipe(dest(destPath));
+                .pipe(mpWxmlDep(tmsConfig, module, isDev))
+                .on('error', (err) => {
+                  fail(`mpWxmlDep编译报错${err}`);
+                })
+                .pipe(dest(newDestPath))
+                .on('error', (err) => {
+                  fail(`wxml编译报错${err}`);
+                });
             },
           },
         );
@@ -113,16 +128,19 @@ module.exports = function (
           globValue,
           {
             module,
-            taskFn: () => {
-              // const srcTask = () => src(globValue, { ...srcOption, since: since(srcTask) });
-              // const srcPipe = srcTask();
-              const srcPipe = src(globValue, { ...srcOption });
+            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(destPath));
+                .pipe(dest(newDestPath))
+                .on('error', (err) => {
+                  fail(`image编译报错${err}`);
+                });
             },
           },
         );
@@ -132,12 +150,15 @@ module.exports = function (
           globValue,
           {
             module,
-            taskFn: () => {
-              // const srcTask = () => src(globValue, { ...srcOption, since: since(srcTask) });
-              // const srcPipe = srcTask();
-              const srcPipe = src(globValue, { ...srcOption });
+            taskFn: (sourceFile, targetPath) => {
+              const newGlobValue = Array.isArray(sourceFile) ? sourceFile : globValue;
+              const newDestPath = targetPath ? targetPath : destPath;
+              const srcPipe = src(newGlobValue, { ...srcOption });
               return srcPipe
-                .pipe(dest(destPath));
+                .pipe(dest(newDestPath))
+                .on('error', (err) => {
+                  fail(`编译报错${err}`);
+                });
             },
           },
         );

package/src/compile/dev.js

@@ -1,15 +1,16 @@
 const path = require('path');
 const fs = require('fs');
 const ora = require('ora');
+const chalk = require('chalk');
 const { parallel, series } = require('gulp');
-const { resolve, mergeMap } = require('../utils/widgets');
+const { resolve, mergeMap, filterField } = 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 watchEvents = ['add', 'change', 'unlink', 'unlinkDir'];
+const watchEvents = ['add', 'change', 'unlink', 'addDir', 'unlinkDir'];
 function excludeGlob(glob) {
   const otherArr = new Set();
   otherArr.add('!**/*.{ttf,otf,woff,eot}');
@@ -35,18 +36,8 @@ function adaptPath(pathDir) {
   newPath = newPath.endsWith('/') ? newPath.slice(0, newPath.length - 1) : newPath;
   return newPath;
 }
-module.exports = async (tmsConfig, newModules, isWatch = true) => {
+module.exports = async (tmsConfig, newModules, isDev = true) => {
   const compileTasksMap = new Map();
-  // 监听app.json
-  if (isWatch) {
-    watch(
-      [resolve('app.json')],
-      { ignoreInitial: false, events: watchEvents },
-      () => buildOutputAppJson(tmsConfig, newModules, isWatch),
-    );
-  } else {
-    buildOutputAppJson(tmsConfig, newModules, isWatch);
-  }
 
   // 监听根目录的文件
   mergeMap(compileTasksMap, compile(tmsConfig, {
@@ -55,10 +46,10 @@ module.exports = async (tmsConfig, newModules, isWatch = true) => {
       // wxss: ['app.less', 'app.wxss'].map(item => resolve(item)),
       // js: ['app.js', 'app.ts'].map(item => resolve(item)),
     },
-    module: { from: '', to: '' },
+    module: { from: resolve(), to: resolve(tmsConfig.outputDir) },
     destPath: resolve(tmsConfig.outputDir),
     srcOption: { allowEmpty: true },
-    isWatch,
+    isDev,
   }));
 
   // 监听模块的文件
@@ -68,18 +59,19 @@ module.exports = async (tmsConfig, newModules, isWatch = true) => {
       ...{ exclude: [] },
       ...module,
     };
+    const modulePath = adaptPath(module.path);
 
-    if (isWatch) {
+    if (isDev) {
       // 监听模块配置文件
       watch(
-        [`${resolve(module.path)}/**/module.config.json`],
+        [`${modulePath}/**/module.config.json`],
         { events: watchEvents },
-        () => buildOutputAppJson(tmsConfig, newModules, isWatch),
+        () => buildOutputAppJson(tmsConfig, newModules, isDev),
+        { from: modulePath, to: modulePath },
       );
     }
 
     const excludes = module.exclude.map(key => `!${resolve(key)}`);
-    const modulePath = adaptPath(module.path);
     const glob = {
       js: [`${modulePath}/**/*.{js,ts,wxs}`, ...excludes],
       json: [`${modulePath}/**/*.json`, `!${modulePath}/**/module.config.json`, ...excludes],
@@ -96,7 +88,7 @@ module.exports = async (tmsConfig, newModules, isWatch = true) => {
       destPath: resolve(tmsConfig.outputDir, module.root),
       module: { from: module.path, to: module.root },
       srcOption: { allowEmpty: true },
-      isWatch,
+      isDev,
     }));
   }
 
@@ -130,7 +122,7 @@ module.exports = async (tmsConfig, newModules, isWatch = true) => {
           to: item.to,
         },
         srcOption: { allowEmpty: true },
-        isWatch,
+        isDev,
       }));
     }
   }
@@ -138,28 +130,45 @@ module.exports = async (tmsConfig, newModules, isWatch = true) => {
   let sTime;
   let eTime;
   const spinner = ora();
-  function end(cb) {
-    if (isWatch) {
+  function start(cb) {
+    info('启动编译...');
+    spinner.start();
+    sTime = new Date().getTime();
+    cb();
+  }
+  async function end(cb) {
+    if (isDev) {
+      // 监听app.json
+      watch(
+        [resolve('app.json')],
+        { ignoreInitial: false, events: watchEvents },
+        () => buildOutputAppJson(tmsConfig, newModules, isDev),
+        { from: resolve(), to: resolve(tmsConfig.outputDir) },
+      );
+      // 监听其他文件
       compileTasksMap.forEach(({ taskFn, module }, globValue) => {
         watch(globValue, { ignoreInitial: true, events: watchEvents }, taskFn, module);
       });
+    } else {
+      buildOutputAppJson(tmsConfig, newModules, isDev);
     }
     eTime = new Date().getTime() - sTime;
-    spinner.succeed(`首次编译完成， 耗时${eTime / 1000}s, 微信开发者工具打开项目即刻预览。`);
+    if (typeof tmsConfig?.hooks?.afterCompile === 'function') {
+      await tmsConfig?.hooks?.afterCompile({
+        isDev,
+        tmsConfig: filterField(tmsConfig, ['gitAccount']),
+        modules: newModules,
+      });
+    }
+    spinner.succeed(chalk.green(`首次编译完成, 耗时${eTime / 1000}s, 微信开发者工具打开项目即可预览。`));
     spinner.stop();
     cb();
   }
 
-  function start(cb) {
-    info('启动编译...');
-    spinner.start();
-    sTime = new Date().getTime();
-    cb();
-  }
-
   const compileTasks = [];
   compileTasksMap.forEach(({ taskFn }) => {
     compileTasks.push(taskFn);
   });
+  // 一次性完成编译任务（编译完成后再添加watch任务-封装到end函数里面）
   series(start, parallel(...compileTasks), end)();
 };

package/src/compile/plugins/gulp-watch/index.js

@@ -0,0 +1,172 @@
+
+/* eslint-disable */
+// 该文件源于npm包 gulp-watch 但内部有bug, 故源码进行单独修改
+const assign = require('object-assign');
+const path = require('path');
+const PluginError = require('plugin-error');
+const fancyLog = require('fancy-log');
+const colors = require('ansi-colors');
+const chokidar = require('chokidar');
+const { Duplex } = require('readable-stream');
+const vinyl = require('vinyl-file');
+const File = require('vinyl');
+const anymatch = require('anymatch');
+const pathIsAbsolute = require('path-is-absolute');
+const globParent = require('glob-parent');
+const slash = require('slash');
+
+function normalizeGlobs(globs) {
+  if (!globs) {
+    throw new PluginError('gulp-watch', 'glob argument required');
+  }
+
+  if (typeof globs === 'string') {
+    globs = [globs];
+  }
+
+  if (!Array.isArray(globs)) {
+    throw new PluginError('gulp-watch', `glob should be String or Array, not ${typeof globs}`);
+  }
+
+  return globs;
+}
+
+function watch(globs, opts, cb) {
+  const originalGlobs = globs;
+  globs = normalizeGlobs(globs);
+
+  if (typeof opts === 'function') {
+    cb = opts;
+    opts = {};
+  }
+
+  opts = assign({}, watch._defaultOptions, opts);
+  cb = cb || function () {};
+
+  function resolveFilepath(filepath) {
+    if (pathIsAbsolute(filepath)) {
+      return path.normalize(filepath);
+    }
+    return path.resolve(opts.cwd || process.cwd(), filepath);
+  }
+
+  function resolveGlob(glob) {
+    let mod = '';
+
+    if (glob[0] === '!') {
+      mod = glob[0];
+      glob = glob.slice(1);
+    }
+
+    return mod + slash(resolveFilepath(glob));
+  }
+  globs = globs.map(resolveGlob);
+
+  const baseForced = Boolean(opts.base);
+  const outputStream = new Duplex({ objectMode: true, allowHalfOpen: true });
+
+  outputStream._write = function _write(file, enc, done) {
+    cb(file);
+    this.push(file);
+    done();
+  };
+
+  outputStream._read = function _read() { };
+
+  const watcher = chokidar.watch(globs, opts);
+
+  opts.events.forEach((ev) => {
+    watcher.on(ev, processEvent.bind(undefined, ev));
+  });
+
+  ['add', 'change', 'unlink', 'addDir', 'unlinkDir', 'error', 'ready', 'raw']
+    .forEach((ev) => {
+      watcher.on(ev, outputStream.emit.bind(outputStream, ev));
+    });
+
+  outputStream.add = function add(newGlobs) {
+    newGlobs = normalizeGlobs(newGlobs)
+      .map(resolveGlob);
+    watcher.add(newGlobs);
+    globs.push.apply(globs, newGlobs);
+  };
+  outputStream.unwatch = watcher.unwatch.bind(watcher);
+  outputStream.close = function () {
+    watcher.close();
+    this.emit('end');
+  };
+
+  function processEvent(event, filepath) {
+    filepath = resolveFilepath(filepath);
+    const fileOpts = assign({}, opts);
+
+    let glob;
+    let currentFilepath = filepath;
+    while (!(glob = globs[anymatch(globs, currentFilepath, true)]) && currentFilepath !== (currentFilepath = path.dirname(currentFilepath))) {} // eslint-disable-line no-empty-blocks/no-empty-blocks
+
+    if (!glob) {
+      console.error('[gulp-watch]没有匹配到glob')
+      return;
+    }
+
+    if (!baseForced) {
+      fileOpts.base = path.normalize(globParent(glob));
+    }
+
+    // Do not stat deleted files
+    if (event === 'unlink' || event === 'unlinkDir' || event === 'addDir') {
+      fileOpts.path = filepath;
+
+      write(event, null, new File(fileOpts));
+      return;
+    }
+
+    // Workaround for early read
+    setTimeout(() => {
+      vinyl.read(filepath, fileOpts).then((file) => {
+        write(event, null, file);
+      });
+    }, opts.readDelay);
+  }
+
+  function write(event, err, file) {
+    if (err) {
+      outputStream.emit('error', err);
+      return;
+    }
+
+    if (opts.verbose) {
+      log(event, file);
+    }
+
+    file.event = event;
+    outputStream.push(file);
+    cb(file);
+  }
+
+  function log(event, file) {
+    event = event[event.length - 1] === 'e' ? `${event}d` : `${event}ed`;
+
+    const msg = [colors.magenta(file.relative), 'was', event];
+
+    if (opts.name) {
+      msg.unshift(`${colors.cyan(opts.name)} saw`);
+    }
+
+    fancyLog.info.apply(null, msg);
+  }
+
+  return outputStream;
+}
+
+// This is not part of the public API as that would lead to global state (singleton) pollution,
+// and allow unexpected interference between unrelated modules that make use of gulp-watch.
+// This can be useful for unit tests and root application configuration, though.
+// Avoid modifying gulp-watch's default options inside a library/reusable package, please.
+watch._defaultOptions = {
+  events: ['add', 'change', 'unlink'],
+  ignoreInitial: true,
+  readDelay: 10,
+};
+
+module.exports = watch;

package/src/compile/plugins/mpJsonDep.js

@@ -49,7 +49,7 @@ function mpJsonDep(
                 }
 
                 // eslint-disable-next-line
-                const reg = new RegExp(`^(\./\.\.\/)+.*\/${includeName}\/(.*)`);
+                const reg = new RegExp(`^(\./|\.\.\/)+.*\/${includeName}\/(.*)`);
                 const regRes = componentPath.match(reg) || [];
                 if (regRes[2]) {
                   const depDestPath = resolve(tmsConfig.outputDir, module.to, includeName, regRes[2]);

package/src/compile/watch.js

@@ -1,29 +1,65 @@
-const watch = require('gulp-watch');
+const watch = require('./plugins/gulp-watch');
 const path = require('path');
 const shellJs = require('shelljs');
-const { info } = require('../utils/log');
+const { info, warn } = require('../utils/log');
 const { resolve } = require('../utils/widgets');
 const { global } = require('../utils/global');
+const { findAllFilesOfDir } = require('../utils/io');
 
-module.exports = function (glob, watchOptions, callback, module) {
-  watch(glob, {
-    readDelay: 100,
+const TIP_MAP = {
+  'package.json': '若依赖有变动，请重新执行tmskit run dev',
+  'module.config.json': '若dependencies字段有变动，需要重新执行tmskit run dev才会生效',
+};
+
+const logTip = (fileName, tipMap) => {
+  // eslint-disable-next-line
+  for (const item in tipMap) {
+    if (fileName.indexOf(item) > -1) {
+      warn(`${fileName}有更新, ${tipMap[item]}`);
+      return;
+    }
+  }
+  info(`${fileName}有更新`);
+};
+
+const getTargetFile = (sourceFile, module, outputDir) => {
+  const sourceFileRelativeModule = path.relative(resolve(module.from), sourceFile);
+  const targetFile = resolve(outputDir, module.to, sourceFileRelativeModule);
+  return targetFile;
+};
+
+module.exports = function (globValue, watchOptions, callback, module) {
+  watch(globValue, {
+    // readDelay: 100,
     ...watchOptions,
   }, (vinyl) => {
-    const file = vinyl.history[0];
-    const fileDirArr = file.replace(/\\/g, '/').split('/');
-    const fileName = fileDirArr.slice(fileDirArr.length - 2).join('/');
+    const sourceFile = vinyl.history[0];
+    const sourceFileDirArr = sourceFile.replace(/\\/g, '/').split('/');
+    const sourceFileName = sourceFileDirArr.slice(sourceFileDirArr.length - 2).join('/');
+
+    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') {
-      const tmsConfig = global.getData('tmsConfig');
-      const anaFileRelativeModule = path.relative(resolve(module.from), file);
-      const anaFileDestFile = resolve(tmsConfig.outputDir, module.to, anaFileRelativeModule);
-      info(`删除${fileName}`);
-      shellJs.rm('-rf', anaFileDestFile);
+      info(`删除${sourceFileName}`);
+      shellJs.rm('-rf', targetFile);
       return;
     }
 
-    info(`更新${fileName}`);
-    return callback(vinyl);
+    logTip(sourceFileName, TIP_MAP);
+    return callback([sourceFile], path.dirname(targetFile));
   });
 };

package/src/config/constant.js

@@ -14,7 +14,7 @@ const TEMPLATE_DIR = path.resolve(CACHE_DIR, 'template');
 const MODULE_CODE_DIR = path.resolve(CACHE_DIR, 'modules_code');
 
 // 脚手架模板代码的具体路径
-const TEMPLATE_PATH = path.resolve(TEMPLATE_DIR, 'tools/tms-cli-template');
+const TEMPLATE_PATH = path.resolve(TEMPLATE_DIR, 'tools/tmskit-template');
 
 // 脚手架的名称
 const TMS_NAME = 'tmskit';
@@ -47,7 +47,6 @@ const ENV = {
 };
 
 const  TEMPLATE_TKIT_DIR = '_tmskit';
-const MODULE_CONFIG_INVALID_KEY = ['entranceDeclare', 'entryPagePath'];
 
 export {
   HOME_DIR,
@@ -64,6 +63,5 @@ export {
   MODULE_CODE_DIR,
   ENV,
   TEMPLATE_TKIT_DIR,
-  MODULE_CONFIG_INVALID_KEY,
   DEFAULT_CLOUD_MODULE_DIR,
 };

package/src/config/defaultTmsConfig.js

@@ -3,7 +3,7 @@ module.exports = {
   // 全局的环境配置项
   envData: {},
   // 模块配置信息
-  modules: [],
+  modules: {},
   cloudDir: 'cloud',
   // 第三方依赖代码需要拷贝到本项目的
   dependencies: {},