file-lane 2.0.2-dev.8 → 2.0.3-beta.1

package/README.md

@@ -1,13 +1,247 @@
-# `file-lane`
+# 项目介绍
 
-用于文件转换，可1个文件转换为1个文件，也可1转多、多转1
+file-lane模块用于文件转换，可实现文件1对1的转换，也可实现1对多、多对1的文件转换。
 
-<img src="./doc/flow.jpg" style="max-width: 1000px; width: 100%"/>
+<img src="./doc/flow-detail.png" style="max-width: 1000px; width: 100%"/>
 
-## Usage
+## 安装使用
+
+- 安装
+
+  `npm i file-lane`
+
+- 快速上手
+
+  ```javascript
+  const { FileLane } = require('file-lane')
+  const { UxLoader } = require('aiot-toolkit/aiotpack')
+  const Path = require('path')
+
+  const projectPath = Path.join(__dirname, '../testProject')
+
+  // 定义项目转换的配置参数，output和module为必要配置内容
+  const projectConfig = {
+    // output指定转换后项目的存储位置
+    get output() {
+      const name = Path.basename(projectPath)
+      const result = `../.temp_${name}`
+      return result
+    },
+    // 转换过程中使用的转换模块配置
+    module: {
+      rules: [
+        {
+          test: [/.+\.ux$/],
+          exclude: [/app\.ux/],
+          loader: [UxLoader]
+        }
+      ]
+    }
+  }
+
+  // 开始执行文件转换
+  new FileLane(projectConfig).start()
+  // 开启watch模式
+  // new FileLane(projectConfig).start({ watch: true })
+  ```
+
+## 参数配置
+
+- 必填参数
+  - [output](#output)
+  - [module](#module)
+- 可选参数
+  - [fileCollector](#fileCollector)
+  - [include](#include)
+  - [exclude](#exclude)
+  - [plugins](#plugins)
+  - [preWorks](#preWorks)
+  - [followWorks](#followWorks)
+  - [watchIgnores](#watchIgnores)
+
+<a id="output">output</a>
+
+描述: 输出目录
+
+参数类型: string
+
+示例:
+
+```
+'temp_project'
+```
+
+<a id="module">module</a>
+
+描述: 文件转换规则集
+
+参数类型: { rules: IRule[] } // IRule：转换规则
+
+```javascript
+interface IRule {
+  // 配置文件
+  test: MatchType
+
+  // 文件的 Loader，从前向后依次执行，前一个 loader 结果做为后一个 loader 的入参
+  loader: ILoaderClass[]
+  exclude?: MatchType
+  include?: MatchType
+}
+```
+
+示例:
 
 ```
-const fileLane = require('file-lane');
+{
+  rules: [
+    {
+      test: [/.+\.ux$/],
+      exclude: [/app\.ux/],
+      loader: [UxLoader]
+    }
+  ]
+}
+
+```
+
+<a id="fileCollector">fileCollector</a>
+
+描述: 文件收集器，输入文件路径，返回待合并的文件路径，常用于多转1，默认值为直接使用源文件
+
+参数类型:
+
+```
+(file: string) => string[]
+```
+
+示例:
+
+```javascript
+// src/a.hml -->[src/a.hml, src/a.js, src/a.css]
+(file: string) => {
+  const fileList = [file]
+  const { dir, name, ext } = path.parse(file)
+
+  if (ext === '.hml') {
+    ['.js', '.css'].map((item) => {
+      const collectFile = path.join(dir, `${name}${item}`)
+      // 若路径真实存在，则push到文件列表中
+      if (fs.existsSync(collectFile)) {
+        fileList.push(collectFile)
+      }
+    })
+    return fileList
+  }
+}
+```
+
+<a id="include">include</a>
+
+描述: 指定文件范围
+
+参数类型:
+
+```
+OneMatchType | OneMatchType[]
+```
+
+示例:
+
+```javascript
+// 匹配包含有src字符串的文件
+include = ['src']
+```
+
+<a id="exclude">exclude</a>
+
+描述: 需排除的文件范围
+
+参数类型:
+
+```
+OneMatchType | OneMatchType[]
+```
+
+示例:
+
+```javascript
+// 排除路径中包含有node_modules字符串的文件
+exclude = [/node_modules/]
+```
+
+<a id="plugins">plugins</a>
+
+描述: 插件，在每个文件转换完成前后，所有文件转换完成前后，在打包完成前后会触发
+
+参数类型:
+
+```
+IPlugin[]
+```
+
+示例:
+
+```
+
+```
+
+<a id="preWorks">preWorks</a>
+
+描述: 前置工作，所有文件转换前的工作
+
+参数类型:
+
+```
+PreWork[]
+```
+
+示例:
+
+```javascript
+preWorks = [validateManifest]
+
+const validateManifest: PreWork<IJavascriptCompileOption>  = async (context) => {
+  // 校验manifest.json文件的内容
+}
+```
+
+<a id="followWorks">followWorks</a>
+
+描述: 后续工作，所有文件转换后的工作
+
+参数类型:
+
+```
+FollowWoker<O>[]
+```
+
+示例:
+
+```javascript
+followWorks = [
+  {
+    worker: toRpk,
+    workerDescribe: 'follow work'
+  }
+]
+
+const toRpk: FollowWork<IJavascriptCompileOption> = async (context, config, compilerOption) => {
+  // 生成rpk逻辑
+}
+```
+
+<a id="watchIgnores">watchIgnores</a>
+
+描述: 配置watch时忽略的文件或者文件夹
+
+参数类型:
+
+```
+MatchType
+```
+
+示例:
 
-// TODO: DEMONSTRATE API
+```javascript
+watchIgnores = [/node_modules/, '/build/', '/dist/']
 ```

package/lib/FileLane.d.ts

@@ -1,25 +1,49 @@
 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> {
     readonly config: IFileLaneConfig<O>;
     readonly compilerOption?: O | undefined;
+    private readonly events?;
     private context;
     private watcher?;
+    /**
+     * 每次编译的数据对象
+     */
     private compilation?;
-    private ws;
+    private changeFileList;
+    private triggerCount;
     /**
      * 实例化FileLane
      * @param config fileLane 配置
      * @param projectPath 项目路径
      * @param compilerOption 编译参数，不同语言的项目具有的参数不同，即使同一项目开发者也会设置不同的参数
      */
-    constructor(config: IFileLaneConfig<O>, projectPath?: string, compilerOption?: O | undefined);
+    constructor(config: IFileLaneConfig<O>, projectPath?: string, compilerOption?: O | undefined, events?: IFileLaneEvents | undefined);
     /**
      * 运行
      * @param params
@@ -35,8 +59,9 @@ declare class FileLane<O = any> {
     }): Promise<void>;
     private validateConfig;
     private processExitHandler;
-    stop(): void;
-    dispose(): void;
+    private sigintHandler;
+    stop(): Promise<void>;
+    dispose(): Promise<void>;
     /**
      *
      * @param fileList 原始文件列表
@@ -45,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;
     /**
@@ -55,13 +89,21 @@ declare class FileLane<O = any> {
     private findLoader;
     private triggerPlugins;
     /**
-     * 运行转换初始的任务
+     * start开始时的准备工作
      */
-    private runPreWorks;
+    private complyBeforeWorks;
     /**
-     * 运行转换后续的任务
+     * start结束后的收尾工作
      */
-    private runFollowWorks;
+    private complyAfterWork;
+    /**
+     * 执行项目转换的前置工作
+     */
+    private complyBeforeCompile;
+    /**
+     * 执行项目转换的后续工作
+     */
+    private complyAfterCompile;
     private watch;
     /**
      * 采集所有要处理的真实文件路径列表
@@ -74,10 +116,15 @@ declare class FileLane<O = any> {
      * @param onChange
      */
     private listenFileChange;
-    private get outputPath();
     /**
      * 清除输出文件夹
      */
     private cleanOutput;
+    /**
+     * 1. 配置的忽略文件夹
+     * 2. 默认应该忽略的文件及文件夹
+     * @returns
+     */
+    private getIgnoreConfig;
 }
 export default FileLane;

package/lib/FileLane.js

@@ -13,22 +13,39 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const shared_utils_1 = require("@aiot-toolkit/shared-utils");
-const ColorConsole_1 = __importDefault(require("@aiot-toolkit/shared-utils/lib/ColorConsole"));
-const FileUtil_1 = __importDefault(require("@aiot-toolkit/shared-utils/lib/utils/FileUtil"));
 const chokidar_1 = __importDefault(require("chokidar"));
 const fs_extra_1 = __importDefault(require("fs-extra"));
 const lodash_1 = __importDefault(require("lodash"));
 const path_1 = __importDefault(require("path"));
-const ws_1 = __importDefault(require("ws"));
 const FileLaneCompilation_1 = __importDefault(require("./FileLaneCompilation"));
 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 {
@@ -38,14 +55,18 @@ class FileLane {
      * @param projectPath 项目路径
      * @param compilerOption 编译参数，不同语言的项目具有的参数不同，即使同一项目开发者也会设置不同的参数
      */
-    constructor(config, projectPath, compilerOption) {
+    constructor(config, projectPath, compilerOption, events) {
         this.config = config;
         this.compilerOption = compilerOption;
+        this.events = events;
+        this.changeFileList = [];
+        this.triggerCount = 0;
         this.processExitHandler = () => {
             this.dispose();
         };
         this.context = FileLaneUtil_1.default.createContext(config.output, projectPath);
         process.on('exit', this.processExitHandler);
+        process.on('SIGINT', this.sigintHandler);
     }
     /**
      * 运行
@@ -56,18 +77,18 @@ class FileLane {
         return __awaiter(this, void 0, void 0, function* () {
             const errorList = this.validateConfig();
             if (errorList && errorList.length) {
-                ColorConsole_1.default.error(`### file-lane ### ${errorList.map((item, index) => `${index + 1}. ${item}`).join('\r\n')}`);
+                shared_utils_1.ColorConsole.error(`### file-lane ### ${errorList.map((item, index) => `${index + 1}. ${item}`).join('\r\n')}`);
                 return;
             }
-            this.cleanOutput();
+            yield this.complyBeforeWorks();
             const fileList = this.collectFile();
             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() {
@@ -117,24 +138,36 @@ class FileLane {
         }
         return result;
     }
-    stop() {
-        this.dispose();
+    sigintHandler() {
         process.exit();
     }
+    stop() {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.watcher) {
+                this.watcher.removeAllListeners();
+                yield this.watcher.close();
+            }
+        });
+    }
     dispose() {
-        if (this.watcher) {
-            this.watcher.close();
-        }
+        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* () {
-            this.initCompilation();
+            var _a;
+            const { onBuildSuccess, onBuildError } = this.events || {};
+            const t1 = Date.now();
+            this.initCompilation(trigger);
             try {
-                yield this.runPreWorks(fileList);
+                yield this.complyBeforeCompile();
                 this.triggerPlugins(new CompilationEvent_1.default(CompilationEvent_1.default.PROJECT_START));
                 for (let item of fileList) {
                     this.triggerPlugins(new FileEvent_1.default(FileEvent_1.default.FILE_START_COMPILATION, FileLaneUtil_1.default.pathToFileParam(item)));
@@ -144,22 +177,37 @@ class FileLane {
                 this.triggerPlugins(new CompilationEvent_1.default(CompilationEvent_1.default.PROJECT_END));
                 // 执行extra
                 this.triggerPlugins(new CompilationEvent_1.default(CompilationEvent_1.default.FLLOW_WORK_START));
-                yield this.runFollowWorks();
+                yield this.complyAfterCompile();
                 this.triggerPlugins(new CompilationEvent_1.default(CompilationEvent_1.default.FLLOW_WORK_END));
-                ColorConsole_1.default.success({
+                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: ColorConsole_1.default.getStyle(shared_utils_1.LOG_LEVEL.Success)
+                    style: shared_utils_1.ColorConsole.getStyle(shared_utils_1.Loglevel.SUCCESS)
                 });
             }
             catch (error) {
-                console.log('error', error);
-                ColorConsole_1.default.throw(`ERROR: build error, ${error || 'unknown error'}`);
+                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();
@@ -196,17 +244,53 @@ 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) {
                 return;
             }
-            const buildPath = this.outputPath;
+            const buildPath = FileLaneUtil_1.default.getOutputPath(this.context);
+            if (!fs_extra_1.default.existsSync(buildPath)) {
+                shared_utils_1.FileUtil.mkdirSync(buildPath, { hidden: true });
+            }
             return Promise.all(fileList.map((item) => {
                 const resolvePath = path_1.default.relative(this.context.projectPath, item.path);
                 // 将相对路径与输出路径拼接，形成最新的文件路径
@@ -215,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);
@@ -234,8 +317,8 @@ class FileLane {
         let loaders = [];
         for (let rule of rules) {
             // 1. 检查filePath是否符合规则test
-            if (FileUtil_1.default.match(parse, rule.test) &&
-                FileUtil_1.default.include(filePath, rule.include, rule.exclude)) {
+            if (shared_utils_1.FileUtil.match(parse, rule.test) &&
+                shared_utils_1.FileUtil.include(filePath, rule.include, rule.exclude)) {
                 // 2. 符合规则就添加到返回列表中
                 loaders.push(...rule.loader);
             }
@@ -250,33 +333,71 @@ class FileLane {
         });
     }
     /**
-     * 运行转换初始的任务
+     * start开始时的准备工作
      */
-    runPreWorks(fileList) {
+    complyBeforeWorks() {
         return __awaiter(this, void 0, void 0, function* () {
-            const { preWorks } = this.config;
-            if (preWorks) {
-                for (let item of preWorks) {
-                    try {
-                        yield item(this.context, fileList, this.config, this.compilerOption);
-                    }
-                    catch (error) {
-                        // prework的item error
-                        ColorConsole_1.default.throw((error === null || error === void 0 ? void 0 : error.toString()) || 'unkonw error');
-                    }
+            const { beforeWorks } = this.config;
+            if (beforeWorks) {
+                for (let item of beforeWorks) {
+                    yield item(this.context);
+                }
+            }
+        });
+    }
+    /**
+     * start结束后的收尾工作
+     */
+    complyAfterWork() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { afterWorks } = this.config;
+            if (afterWorks) {
+                for (let item of afterWorks) {
+                    yield item(this.context);
                 }
             }
         });
     }
     /**
-     * 运行转换后续的任务
+     * 执行项目转换的前置工作
      */
-    runFollowWorks() {
+    complyBeforeCompile() {
         return __awaiter(this, void 0, void 0, function* () {
-            const { followWorks } = this.config;
-            if (followWorks) {
-                for (let item of followWorks) {
-                    yield item(this.context, this.config, this.compilerOption);
+            const { beforeCompile } = this.config;
+            if (beforeCompile) {
+                for (let item of beforeCompile) {
+                    yield item({
+                        context: this.context,
+                        config: this.config,
+                        compilerOption: this.compilerOption,
+                        compalition: this.compilation
+                    });
+                }
+            }
+        });
+    }
+    /**
+     * 执行项目转换的后续工作
+     */
+    complyAfterCompile() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { afterCompile } = this.config;
+            if (afterCompile) {
+                for (let item of afterCompile) {
+                    try {
+                        shared_utils_1.ColorConsole.info(`FollowWork: ${item.workerDescribe} start`);
+                        yield item.worker({
+                            context: this.context,
+                            config: this.config,
+                            compilerOption: this.compilerOption,
+                            compalition: this.compilation
+                        });
+                        shared_utils_1.ColorConsole.info(`FollowWork: ${item.workerDescribe} end`);
+                    }
+                    catch (error) {
+                        shared_utils_1.ColorConsole.throw(`FollowWork: ${item.workerDescribe} error, ${error}`);
+                        process.exit();
+                    }
                 }
             }
         });
@@ -284,18 +405,15 @@ class FileLane {
     watch() {
         return __awaiter(this, void 0, void 0, function* () {
             // 监听文件变化，并触发 build
-            this.listenFileChange(() => __awaiter(this, void 0, void 0, function* () {
-                var _a, _b, _c;
-                const fileList = this.collectFile();
-                if (!this.ws && ((_a = this.compilerOption) === null || _a === void 0 ? void 0 : _a.hasOwnProperty('server'))) {
-                    const port = (_b = this.compilerOption.server) === null || _b === void 0 ? void 0 : _b.port;
-                    this.ws = new ws_1.default(`ws://localhost:${port}`);
-                }
-                yield this.build(fileList);
-                (_c = this.ws) === null || _c === void 0 ? void 0 : _c.send(JSON.stringify({
-                    type: 'restart'
-                }));
-            }));
+            const onChange = () => __awaiter(this, void 0, void 0, function* () {
+                const fileList = this.config.collectFile
+                    ? this.config.collectFile(this.changeFileList)
+                    : this.collectFile();
+                // 开始编译前，记录列表置空
+                this.changeFileList = [];
+                yield this.build(fileList, FileLaneTriggerType_1.default.UPDATE);
+            });
+            this.listenFileChange(onChange);
         });
     }
     /**
@@ -308,8 +426,8 @@ class FileLane {
         let files = [];
         if (entryFileList) {
             entryFileList.forEach((filePath) => {
-                if (FileUtil_1.default.include(filePath, this.config.include, this.config.exclude)) {
-                    ColorConsole_1.default.log(`### file-lane ### file change: ${filePath}`);
+                if (shared_utils_1.FileUtil.include(filePath, this.config.include, this.config.exclude)) {
+                    shared_utils_1.ColorConsole.log(`### file-lane ### file change: ${filePath}`);
                     files.push(filePath);
                 }
             });
@@ -318,7 +436,7 @@ class FileLane {
             // 1.取出projectPath
             const projectPath = this.context.projectPath;
             // 2. 循环文件夹，取出所有匹配的文件路径
-            files = FileUtil_1.default.readAlldirSync(projectPath, this.config.include, this.config.exclude);
+            files = shared_utils_1.FileUtil.readAlldirSync(projectPath, this.config.include, this.config.exclude);
         }
         return files;
     }
@@ -328,54 +446,77 @@ class FileLane {
      */
     listenFileChange(onChange) {
         const watcher = chokidar_1.default.watch(this.context.projectPath, {
-            ignored: this.config.watchIgnores
+            ignored: this.getIgnoreConfig()
         });
         const throttledOnChange = lodash_1.default.throttle(onChange, 1000, {
-            leading: true,
-            trailing: false
+            leading: false,
+            trailing: true
         });
-        const handler = (filePath) => {
+        const handler = (path, type) => {
             const { exclude, include } = this.config;
-            // 判断是否为删除，执行onChange回调
-            if (FileUtil_1.default.include(filePath, include, exclude)) {
-                throttledOnChange([filePath]);
+            // 执行onChange回调
+            const validFile = shared_utils_1.FileUtil.include(path, include, exclude);
+            if (validFile) {
+                this.changeFileList.push({ path, type });
+                throttledOnChange();
             }
         };
         watcher
             .on('ready', () => {
-            ColorConsole_1.default.log(`### file-lane ### Initial scan complete. Ready for Watch.`);
+            shared_utils_1.ColorConsole.log(`### file-lane ### Initial scan complete. Ready for Watch.`);
             watcher
                 .on('add', (path) => {
                 // 监听文件添加事件
-                handler(path);
+                handler(path, IChangedFile_1.HandlerType.ADD);
             })
                 .on('change', (path) => {
                 // 监听文件修改事件
-                handler(path);
+                handler(path, IChangedFile_1.HandlerType.CHANGE);
             })
                 .on('unlink', (filePath) => {
                 // 监听文件删除事件
-                handler(filePath);
+                handler(filePath, IChangedFile_1.HandlerType.UNLINK);
             });
         })
             .on('error', (error) => {
             // 监听错误
             FileLaneUtil_1.default.checkError(error.message);
+            watcher.close();
         });
         if (this.watcher) {
             this.watcher.close();
         }
         this.watcher = watcher;
     }
-    get outputPath() {
-        const { output, projectPath } = this.context;
-        return path_1.default.join(projectPath, output);
-    }
     /**
      * 清除输出文件夹
      */
     cleanOutput() {
-        fs_extra_1.default.removeSync(this.outputPath);
+        return __awaiter(this, void 0, void 0, function* () {
+            shared_utils_1.FileUtil.del(FileLaneUtil_1.default.getOutputPath(this.context));
+        });
+    }
+    /**
+     * 1. 配置的忽略文件夹
+     * 2. 默认应该忽略的文件及文件夹
+     * @returns
+     */
+    getIgnoreConfig() {
+        let ignoreList = [];
+        // 1.
+        if (this.config.watchIgnores) {
+            if (Array.isArray(this.config.watchIgnores)) {
+                ignoreList.push(...this.config.watchIgnores);
+            }
+            else {
+                ignoreList.push(this.config.watchIgnores);
+            }
+        }
+        // 2. 忽略.开头的隐藏文件夹
+        ignoreList.push(/(^|[\/\\])\../);
+        // 3. 忽略output目录
+        ignoreList.push(path_1.default.join(this.context.projectPath, this.config.output));
+        return ignoreList;
     }
 }
 exports.default = FileLane;

package/lib/FileLaneCompilation.d.ts

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

package/lib/FileLaneCompilation.js

@@ -3,10 +3,27 @@ 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
  */
 class FileLaneCompilation extends AsyncEventDispatcher_1.default {
+    constructor() {
+        super(...arguments);
+        this.buildFileList = [];
+        /**
+         * 触发方式
+         *
+         */
+        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/index.d.ts

@@ -1,7 +1,9 @@
 import FileLane from './FileLane';
-import IFileLaneConfig from './interface/IFileLaneConfig';
+import IFileLaneConfig, { FollowWork, PreWork } from './interface/IFileLaneConfig';
 import IFileLaneContext from './interface/IFileLaneContext';
 import IFileParam from './interface/IFileParam';
 import ILoader from './interface/ILoader';
 import IPlugin from './interface/IPlugin';
-export { FileLane, IFileLaneConfig, IFileLaneContext, IFileParam, ILoader, IPlugin };
+import FileLaneUtil from './utils/FileLaneUtil';
+export { FileLane, IFileLaneConfig, IFileLaneContext, IFileParam, ILoader, IPlugin, FileLaneUtil, PreWork, FollowWork };
+export default FileLane;

package/lib/index.js

@@ -3,6 +3,9 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.FileLane = void 0;
+exports.FileLaneUtil = exports.FileLane = void 0;
 const FileLane_1 = __importDefault(require("./FileLane"));
 exports.FileLane = FileLane_1.default;
+const FileLaneUtil_1 = __importDefault(require("./utils/FileLaneUtil"));
+exports.FileLaneUtil = FileLaneUtil_1.default;
+exports.default = FileLane_1.default;

package/lib/interface/IChangedFile.d.ts

@@ -0,0 +1,9 @@
+export interface IChangedFile {
+    path: string;
+    type: HandlerType;
+}
+export declare enum HandlerType {
+    ADD = 0,
+    CHANGE = 1,
+    UNLINK = 2
+}

package/lib/interface/IChangedFile.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HandlerType = void 0;
+var HandlerType;
+(function (HandlerType) {
+    HandlerType[HandlerType["ADD"] = 0] = "ADD";
+    HandlerType[HandlerType["CHANGE"] = 1] = "CHANGE";
+    HandlerType[HandlerType["UNLINK"] = 2] = "UNLINK";
+})(HandlerType || (exports.HandlerType = HandlerType = {}));

package/lib/interface/IFileLaneConfig.d.ts

@@ -1,14 +1,38 @@
-import { MatchType } from '@aiot-toolkit/shared-utils/lib/utils/FileUtil';
+import { MatchType } from '@aiot-toolkit/shared-utils';
 import IFileLaneContext from './IFileLaneContext';
 import ILoader from './ILoader';
 import IPlugin from './IPlugin';
+import FileLaneCompilation from '../FileLaneCompilation';
+import { IChangedFile } from './IChangedFile';
 export type ILoaderClass = (new (...args: any[]) => ILoader) & {
     raw?: boolean;
 };
+export interface IRule {
+    /**
+     * 配置文件
+     */
+    test: MatchType;
+    /**
+     * 文件的 Loader，从前向后依次执行，前一个 loader 结果做为后一个 loader 的入参
+     */
+    loader: ILoaderClass[];
+    exclude?: MatchType;
+    include?: MatchType;
+}
 /**
  * IFileLaneConfig
  */
 export default interface IFileLaneConfig<O = any> {
+    /**
+     * 项目文件采集器
+     *
+     * @param entryFileList 输入的文件列表
+     *
+     * @returns 返回项目中所有待处理的文件路径
+     *
+     * @description 用于采集所有要处理的真实文件路径列表，或者输入文件列表中要处理的真实文件路径列表
+     */
+    collectFile?: (entryFileList?: IChangedFile[]) => string[];
     /**
      * 文件收集器
      *
@@ -45,15 +69,7 @@ export default interface IFileLaneConfig<O = any> {
         /**
          * 转换规则
          */
-        rules: {
-            /**
-             * 配置文件
-             */
-            test: MatchType;
-            loader: ILoaderClass[];
-            exclude?: MatchType;
-            include?: MatchType;
-        }[];
+        rules: IRule[];
     };
     /**
      * 插件
@@ -64,25 +80,43 @@ export default interface IFileLaneConfig<O = any> {
      */
     plugins?: IPlugin[];
     /**
-     * 前置工作
-     *
-     * @param context 上下文
-     * @param fileList 待转换的文件列表
-     * @returns
+     * 启动阶段的准备工作
+     */
+    beforeWorks?: BeforeWork[];
+    /**
+     * 收尾阶段的工作
      */
-    preWorks?: PreWork[];
+    afterWorks?: AfterWork[];
     /**
-     * 转换结束后续的工作
+     * 项目转换的前置工作
+     */
+    beforeCompile?: PreWork[];
+    /**
+     * 项目转换的后续工作
      *
      * xts--[zip]
      * ux--[webpack, zip]
      * uxInspect--[webpack, zipPhone, zipWatch, zipTv]
      */
-    followWorks?: FollowWork<O>[];
+    afterCompile?: FollowWoker<O>[];
     /**
      * 配置watch时忽略的文件或者文件夹
      */
     watchIgnores?: MatchType;
+    projectPath: string;
 }
-export type FollowWork<O = any> = (context: IFileLaneContext, config?: IFileLaneConfig, compilerOption?: O) => Promise<any>;
-export type PreWork<O = any> = (context: IFileLaneContext, fileList: string[], config: IFileLaneConfig, compilerOption?: O) => Promise<any>;
+type FollowWoker<O> = {
+    worker: FollowWork<O>;
+    workerDescribe?: string;
+};
+type CompileParam<O = any> = {
+    context: IFileLaneContext;
+    config: IFileLaneConfig;
+    compilerOption?: O;
+    compalition?: FileLaneCompilation;
+};
+export type BeforeWork = (context: IFileLaneContext) => Promise<any>;
+export type PreWork<O = any> = (preWorkParams: CompileParam<O>) => Promise<any>;
+export type FollowWork<O = any> = (followParams: CompileParam<O>) => Promise<any>;
+export type AfterWork = (context: IFileLaneContext) => Promise<any>;
+export {};

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/IFileParam.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 /**
  * IFileParam
  */

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/lib/utils/FileLaneUtil.d.ts

@@ -11,14 +11,8 @@ declare class FileLaneUtil {
      * @returns
      */
     static pathToFileParam(path: string, readContent?: boolean): IFileParam;
-    /**
-     * 将buildPath文件夹的内容压缩成zip包，放置于targetPath路径下
-     * @param buildPath
-     * @param targetPath
-     * @param zipRootDirNames 可自定义压缩包内最外层目录的名称
-     */
-    static zipProject(buildPath: string[], targetFile: string, zipRootDirNames?: string[]): Promise<void>;
     static createContext(output: string, projectPath?: string): IFileLaneContext;
     static checkError(message: string): void;
+    static getOutputPath(context: IFileLaneContext): string;
 }
 export default FileLaneUtil;

package/lib/utils/FileLaneUtil.js

@@ -1,20 +1,9 @@
 "use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const shared_utils_1 = require("@aiot-toolkit/shared-utils");
-const ColorConsole_1 = __importDefault(require("@aiot-toolkit/shared-utils/lib/ColorConsole"));
-const archiver_1 = __importDefault(require("archiver"));
 const fs_extra_1 = __importDefault(require("fs-extra"));
 const path_1 = __importDefault(require("path"));
 /**
@@ -40,49 +29,6 @@ class FileLaneUtil {
             content
         };
     }
-    /**
-     * 将buildPath文件夹的内容压缩成zip包，放置于targetPath路径下
-     * @param buildPath
-     * @param targetPath
-     * @param zipRootDirNames 可自定义压缩包内最外层目录的名称
-     */
-    static zipProject(buildPath, targetFile, zipRootDirNames) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return new Promise((resolve, reject) => {
-                const output = fs_extra_1.default.createWriteStream(targetFile);
-                const archive = archiver_1.default.create('zip', {
-                    zlib: { level: 9 }
-                });
-                // 监听错误
-                archive.on('error', (err) => {
-                    ColorConsole_1.default.throw(`${err.message}`);
-                    reject();
-                });
-                // 监听写入流打开的事件
-                output.on('open', () => {
-                    ColorConsole_1.default.info(`Write stream is open`);
-                });
-                output.on('close', () => {
-                    ColorConsole_1.default.info(`Write stream is closed`);
-                    resolve();
-                });
-                // 将压缩文件导入到输出流中
-                archive.pipe(output);
-                // 指定压缩目录
-                buildPath.forEach((folder, index) => {
-                    const folderName = path_1.default.basename(folder); // 获取文件夹名
-                    if (zipRootDirNames && zipRootDirNames[index]) {
-                        archive.directory(folder, zipRootDirNames[index]);
-                    }
-                    else {
-                        archive.directory(folder, folderName);
-                    }
-                });
-                // 完成压缩，关闭输出流
-                archive.finalize();
-            });
-        });
-    }
     static createContext(output, projectPath) {
         const cwd = process.cwd();
         return {
@@ -93,14 +39,20 @@ class FileLaneUtil {
     }
     static checkError(message) {
         if (message.includes('System limit for number of file watchers reached')) {
-            ColorConsole_1.default.error('There are too many files to watch, ', {
+            shared_utils_1.ColorConsole.error('There are too many files to watch, ', {
                 word: 'please configure the content to be ignored.',
                 style: {
-                    bgColor: ColorConsole_1.default.getStyle(shared_utils_1.LOG_LEVEL.Error).color || '#FF0000'
+                    bgColor: shared_utils_1.ColorConsole.getStyle(shared_utils_1.Loglevel.ERROR).color || '#FF0000'
                 }
             }, '(For example, node_modules)');
         }
-        ColorConsole_1.default.throw(`### file-lane ### watch error ${message}`);
+        else {
+            shared_utils_1.ColorConsole.throw(`### file-lane ### watch error ${message}`);
+        }
+    }
+    static getOutputPath(context) {
+        const { output, projectPath } = context;
+        return path_1.default.join(projectPath, output);
     }
 }
 exports.default = FileLaneUtil;

package/package.json

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