file-lane 2.0.2 → 2.0.3-beta.1

package/lib/FileLane.d.ts

@@ -1,9 +1,28 @@
 import IFileLaneConfig from './interface/IFileLaneConfig';
+import IFileLaneEvents from './interface/IFileLaneEvents';
 /**
  * FileLane
  *
  * 文件车道，用于将文件进行对应转换，支持1对1、1对N、N对1
  *
+ * 打包过程中，有以下事件
+ * 1. 打包成功：onBuildSuccess
+ * 2. 打包失败: onBuildError
+ * 3. 产生日志: onLog
+ *
+ * @example
+ * ```
+ * new FileLane<IJavascriptCompileOption>(
+ * fileLaneConfig,
+ * projectPath,
+ * compilerOption,
+ * {
+ *   onBuildSuccess: (data) => {},
+ *   onBuildError: (data) => {},
+ *   onLog: (logs) => {}
+ * }).start()
+ * ```
+ *
  * @description
  */
 declare class FileLane<O = any> {
@@ -12,19 +31,19 @@ declare class FileLane<O = any> {
     private readonly events?;
     private context;
     private watcher?;
+    /**
+     * 每次编译的数据对象
+     */
     private compilation?;
     private changeFileList;
+    private triggerCount;
     /**
      * 实例化FileLane
      * @param config fileLane 配置
      * @param projectPath 项目路径
      * @param compilerOption 编译参数，不同语言的项目具有的参数不同，即使同一项目开发者也会设置不同的参数
      */
-    constructor(config: IFileLaneConfig<O>, projectPath?: string, compilerOption?: O | undefined, events?: {
-        onBuildSuccess?: (data: {
-            costTime: number;
-        }) => void;
-    } | undefined);
+    constructor(config: IFileLaneConfig<O>, projectPath?: string, compilerOption?: O | undefined, events?: IFileLaneEvents | undefined);
     /**
      * 运行
      * @param params
@@ -41,8 +60,8 @@ declare class FileLane<O = any> {
     private validateConfig;
     private processExitHandler;
     private sigintHandler;
-    stop(): void;
-    dispose(): void;
+    stop(): Promise<void>;
+    dispose(): Promise<void>;
     /**
      *
      * @param fileList 原始文件列表
@@ -51,6 +70,15 @@ declare class FileLane<O = any> {
     private initCompilation;
     private buildFile;
     private runLoaders;
+    /**
+     * 处理日志
+     * 1. 触发onLog事件
+     * 2. 如果有错误日志，则抛出错误
+     * @param logs
+     * @param onError
+     * @returns
+     */
+    private handlerLogs;
     private writeFiles;
     private runLoader;
     /**

package/lib/FileLane.js

@@ -22,11 +22,30 @@ const CompilationEvent_1 = __importDefault(require("./event/CompilationEvent"));
 const FileEvent_1 = __importDefault(require("./event/FileEvent"));
 const FileLaneUtil_1 = __importDefault(require("./utils/FileLaneUtil"));
 const IChangedFile_1 = require("./interface/IChangedFile");
+const FileLaneTriggerType_1 = __importDefault(require("./enum/FileLaneTriggerType"));
 /**
  * FileLane
  *
  * 文件车道，用于将文件进行对应转换，支持1对1、1对N、N对1
  *
+ * 打包过程中，有以下事件
+ * 1. 打包成功：onBuildSuccess
+ * 2. 打包失败: onBuildError
+ * 3. 产生日志: onLog
+ *
+ * @example
+ * ```
+ * new FileLane<IJavascriptCompileOption>(
+ * fileLaneConfig,
+ * projectPath,
+ * compilerOption,
+ * {
+ *   onBuildSuccess: (data) => {},
+ *   onBuildError: (data) => {},
+ *   onLog: (logs) => {}
+ * }).start()
+ * ```
+ *
  * @description
  */
 class FileLane {
@@ -41,6 +60,7 @@ class FileLane {
         this.compilerOption = compilerOption;
         this.events = events;
         this.changeFileList = [];
+        this.triggerCount = 0;
         this.processExitHandler = () => {
             this.dispose();
         };
@@ -65,10 +85,10 @@ class FileLane {
             if (!fileList || !fileList.length) {
                 return;
             }
-            yield this.build(fileList);
             if (params === null || params === void 0 ? void 0 : params.watch) {
                 this.watch();
             }
+            yield this.build(fileList, FileLaneTriggerType_1.default.START);
         });
     }
     validateConfig() {
@@ -122,24 +142,30 @@ class FileLane {
         process.exit();
     }
     stop() {
-        process.exit();
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.watcher) {
+                this.watcher.removeAllListeners();
+                yield this.watcher.close();
+            }
+        });
     }
     dispose() {
-        this.complyAfterWork();
-        if (this.watcher) {
-            this.watcher.close();
-        }
-        this.cleanOutput();
+        return __awaiter(this, void 0, void 0, function* () {
+            this.complyAfterWork();
+            yield this.stop();
+            this.cleanOutput();
+        });
     }
     /**
      *
      * @param fileList 原始文件列表
      */
-    build(fileList) {
+    build(fileList, trigger) {
         return __awaiter(this, void 0, void 0, function* () {
-            const { onBuildSuccess } = this.events || {};
+            var _a;
+            const { onBuildSuccess, onBuildError } = this.events || {};
             const t1 = Date.now();
-            this.initCompilation();
+            this.initCompilation(trigger);
             try {
                 yield this.complyBeforeCompile();
                 this.triggerPlugins(new CompilationEvent_1.default(CompilationEvent_1.default.PROJECT_START));
@@ -153,22 +179,35 @@ class FileLane {
                 this.triggerPlugins(new CompilationEvent_1.default(CompilationEvent_1.default.FLLOW_WORK_START));
                 yield this.complyAfterCompile();
                 this.triggerPlugins(new CompilationEvent_1.default(CompilationEvent_1.default.FLLOW_WORK_END));
-                onBuildSuccess === null || onBuildSuccess === void 0 ? void 0 : onBuildSuccess({ costTime: Date.now() - t1 });
+                onBuildSuccess === null || onBuildSuccess === void 0 ? void 0 : onBuildSuccess({
+                    costTime: Date.now() - t1,
+                    info: (_a = this.compilation) === null || _a === void 0 ? void 0 : _a.info
+                });
                 shared_utils_1.ColorConsole.success({
                     word: 'Success: build finish!',
                     style: shared_utils_1.ColorConsole.getStyle(shared_utils_1.Loglevel.SUCCESS)
                 });
             }
             catch (error) {
-                shared_utils_1.ColorConsole.throw(`ERROR: `, { word: 'build error' }, `, ${error || 'unknown error'}`);
-                // 结束任务
-                process.exit();
+                if (onBuildError) {
+                    onBuildError === null || onBuildError === void 0 ? void 0 : onBuildError(error);
+                }
+                else {
+                    shared_utils_1.ColorConsole.throw(`ERROR: `, { word: 'build error' }, `, ${error || 'unknown error'}`);
+                }
+                // 非监听模式，则结束任务
+                if (!this.watcher) {
+                    process.exit();
+                }
             }
         });
     }
-    initCompilation() {
+    initCompilation(trigger) {
         const { plugins } = this.config;
         const compilation = new FileLaneCompilation_1.default();
+        compilation.trigger = trigger;
+        compilation.triggerCount = ++this.triggerCount;
+        compilation.info.trigger = trigger;
         plugins === null || plugins === void 0 ? void 0 : plugins.forEach((item) => {
             item.compilation = compilation;
             item.apply();
@@ -205,11 +244,44 @@ class FileLane {
                         }
                     }
                 });
-                result = yield this.runLoader(result, item);
+                const loader = new item();
+                result = yield this.runLoader(result, loader);
+                if (loader.logs) {
+                    this.handlerLogs(loader.logs, () => {
+                        throw new Error(`loader error: ${item.name}`);
+                    });
+                }
             }
             return result;
         });
     }
+    /**
+     * 处理日志
+     * 1. 触发onLog事件
+     * 2. 如果有错误日志，则抛出错误
+     * @param logs
+     * @param onError
+     * @returns
+     */
+    handlerLogs(logs, onError) {
+        var _a;
+        if (!(logs === null || logs === void 0 ? void 0 : logs.length)) {
+            return;
+        }
+        const onLog = (_a = this.events) === null || _a === void 0 ? void 0 : _a.onLog;
+        if (onLog) {
+            onLog(logs);
+        }
+        else {
+            logs.forEach((item) => {
+                shared_utils_1.ColorConsole.logger(item);
+            });
+        }
+        const hasError = logs.find((item) => item.level && [shared_utils_1.Loglevel.ERROR, shared_utils_1.Loglevel.THROW].includes(item.level));
+        if (hasError) {
+            onError();
+        }
+    }
     writeFiles(fileList) {
         return __awaiter(this, void 0, void 0, function* () {
             if (!fileList || !fileList.length) {
@@ -227,9 +299,8 @@ class FileLane {
             }));
         });
     }
-    runLoader(fileList, loaderType) {
+    runLoader(fileList, loader) {
         return __awaiter(this, void 0, void 0, function* () {
-            const loader = new loaderType();
             loader.context = this.context;
             loader.compilerOption = this.compilerOption;
             return loader.parser(fileList);
@@ -340,7 +411,7 @@ class FileLane {
                     : this.collectFile();
                 // 开始编译前，记录列表置空
                 this.changeFileList = [];
-                yield this.build(fileList);
+                yield this.build(fileList, FileLaneTriggerType_1.default.UPDATE);
             });
             this.listenFileChange(onChange);
         });

package/lib/FileLaneCompilation.d.ts

@@ -1,3 +1,4 @@
+import FileLaneTriggerType from './enum/FileLaneTriggerType';
 import AsyncEventDispatcher from './event/asyncEvent/AsyncEventDispatcher';
 import IFileParam from './interface/IFileParam';
 /**
@@ -5,6 +6,18 @@ import IFileParam from './interface/IFileParam';
  */
 declare class FileLaneCompilation extends AsyncEventDispatcher {
     buildFileList: IFileParam<any>[];
-    diffJson: string[];
+    /**
+     * 触发方式
+     *
+     */
+    trigger: FileLaneTriggerType;
+    /**
+     * 触发次数
+     */
+    triggerCount: number;
+    info: {
+        trigger: FileLaneTriggerType;
+        [key: string]: any;
+    };
 }
 export default FileLaneCompilation;

package/lib/FileLaneCompilation.js

@@ -3,6 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+const FileLaneTriggerType_1 = __importDefault(require("./enum/FileLaneTriggerType"));
 const AsyncEventDispatcher_1 = __importDefault(require("./event/asyncEvent/AsyncEventDispatcher"));
 /**
  * FileLaneCompilation
@@ -11,7 +12,18 @@ class FileLaneCompilation extends AsyncEventDispatcher_1.default {
     constructor() {
         super(...arguments);
         this.buildFileList = [];
-        this.diffJson = [];
+        /**
+         * 触发方式
+         *
+         */
+        this.trigger = FileLaneTriggerType_1.default.START;
+        /**
+         * 触发次数
+         */
+        this.triggerCount = 0;
+        this.info = {
+            trigger: FileLaneTriggerType_1.default.START
+        };
     }
 }
 exports.default = FileLaneCompilation;

package/lib/enum/FileLaneTriggerType.d.ts

@@ -0,0 +1,8 @@
+/**
+ * FileLaneTriggerType
+ */
+declare enum FileLaneTriggerType {
+    START = 1,
+    UPDATE = 2
+}
+export default FileLaneTriggerType;

package/lib/enum/FileLaneTriggerType.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * FileLaneTriggerType
+ */
+var FileLaneTriggerType;
+(function (FileLaneTriggerType) {
+    FileLaneTriggerType[FileLaneTriggerType["START"] = 1] = "START";
+    FileLaneTriggerType[FileLaneTriggerType["UPDATE"] = 2] = "UPDATE";
+})(FileLaneTriggerType || (FileLaneTriggerType = {}));
+exports.default = FileLaneTriggerType;

package/lib/interface/IFileLaneConfig.d.ts

@@ -103,6 +103,7 @@ export default interface IFileLaneConfig<O = any> {
      * 配置watch时忽略的文件或者文件夹
      */
     watchIgnores?: MatchType;
+    projectPath: string;
 }
 type FollowWoker<O> = {
     worker: FollowWork<O>;

package/lib/interface/IFileLaneEvents.d.ts

@@ -0,0 +1,52 @@
+import { ILog } from '@aiot-toolkit/shared-utils/lib/interface/ILog';
+import FileLaneTriggerType from '../enum/FileLaneTriggerType';
+/**
+ * IFileLaneEvents
+ */
+export default interface IFileLaneEvents {
+    /**
+     * 转换成功
+     * @param data
+     * @returns
+     */
+    onBuildSuccess?: (data: IFileLaneSuccessData) => void;
+    /**
+     * 转换失败
+     * @default 错误消息打印到控制台
+     * @param error
+     * @returns
+     */
+    onBuildError?: (error: unknown) => void;
+    /**
+     * 日志触发的方法，打包过程中可能多次触发
+     * @default 日志打印到控制台
+     * @param logs
+     * @returns
+     */
+    onLog?: (logs: ILog[]) => void;
+}
+export interface IFileLaneSuccessData {
+    /**
+     * 耗时(毫秒)
+     */
+    costTime: number;
+    info?: {
+        /**
+         * 触发类型
+         */
+        trigger: FileLaneTriggerType;
+        /**
+         * rpk 文件绝对路径
+         */
+        rpk?: string;
+        /**
+         * 差异文件列表
+         */
+        diffList?: string[];
+        /**
+         * 差异文件压缩包
+         */
+        diffFile?: string;
+        [key: string]: any;
+    };
+}

package/lib/interface/IFileLaneEvents.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/interface/ILoader.d.ts

@@ -1,3 +1,4 @@
+import { ILog } from '@aiot-toolkit/shared-utils/lib/interface/ILog';
 import IFileLaneContext from './IFileLaneContext';
 import IFileParam from './IFileParam';
 /**
@@ -7,4 +8,10 @@ export default interface ILoader {
     context?: IFileLaneContext;
     compilerOption?: any;
     parser(files: IFileParam[]): Promise<IFileParam[]> | IFileParam[];
+    /**
+     * 日志列表
+     *
+     * 其中有 `THROW` `ERROR` 时，会中断打包，并触发 `onBuildError` 事件
+     */
+    logs?: ILog[];
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "file-lane",
-  "version": "2.0.2",
+  "version": "2.0.3-beta.1",
   "description": "File conversion tool, can be one-to-one, one to N, N to one",
   "keywords": [
     "file",
@@ -20,7 +20,7 @@
     "test": "node ./__tests__/file-lane.test.js"
   },
   "dependencies": {
-    "@aiot-toolkit/shared-utils": "2.0.2",
+    "@aiot-toolkit/shared-utils": "2.0.3-beta.1",
     "chokidar": "^3.6.0",
     "fs-extra": "^11.2.0",
     "lodash": "^4.17.21"
@@ -28,5 +28,5 @@
   "devDependencies": {
     "@types/fs-extra": "^11.0.4"
   },
-  "gitHead": "8ca4bf2ed7bcf11911e5c514696951bdba4fc12d"
+  "gitHead": "77b1b0aab9b5c227b5cc355b585a7c93761cc9a3"
 }