file-lane 2.0.2-beta.13 → 2.0.2-beta.14

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

@@ -20,7 +20,9 @@ declare class FileLane<O = any> {
      * @param compilerOption 编译参数，不同语言的项目具有的参数不同，即使同一项目开发者也会设置不同的参数
      */
     constructor(config: IFileLaneConfig<O>, projectPath?: string, compilerOption?: O | undefined, events?: {
-        onBuildSuccess?: (() => void) | undefined;
+        onBuildSuccess?: ((data: {
+            costTime: number;
+        }) => void) | undefined;
     } | undefined);
     /**
      * 运行
@@ -57,13 +59,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;
     /**
      * 采集所有要处理的真实文件路径列表
@@ -76,7 +86,6 @@ declare class FileLane<O = any> {
      * @param onChange
      */
     private listenFileChange;
-    private get outputPath();
     /**
      * 清除输出文件夹
      */

package/lib/FileLane.js

@@ -58,7 +58,7 @@ class FileLane {
                 shared_utils_1.ColorConsole.error(`### file-lane ### ${errorList.map((item, index) => `${index + 1}. ${item}`).join('\r\n')}`);
                 return;
             }
-            yield this.cleanOutput();
+            yield this.complyBeforeWorks();
             const fileList = this.collectFile();
             if (!fileList || !fileList.length) {
                 return;
@@ -121,6 +121,7 @@ class FileLane {
         process.exit();
     }
     dispose() {
+        this.complyAfterWork();
         if (this.watcher) {
             this.watcher.close();
         }
@@ -132,9 +133,10 @@ class FileLane {
     build(fileList) {
         return __awaiter(this, void 0, void 0, function* () {
             const { onBuildSuccess } = this.events || {};
+            const t1 = Date.now();
             this.initCompilation();
             try {
-                yield this.runPreWorks(fileList);
+                yield this.complyBeforeCompile(fileList);
                 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,13 +146,13 @@ 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));
+                onBuildSuccess === null || onBuildSuccess === void 0 ? void 0 : onBuildSuccess({ costTime: Date.now() - t1 });
                 shared_utils_1.ColorConsole.success({
                     word: 'Success: build finish!',
                     style: shared_utils_1.ColorConsole.getStyle(shared_utils_1.Loglevel.SUCCESS)
                 });
-                onBuildSuccess === null || onBuildSuccess === void 0 ? void 0 : onBuildSuccess();
             }
             catch (error) {
                 console.log('FileLane error', error);
@@ -209,7 +211,7 @@ class FileLane {
             if (!fileList || !fileList.length) {
                 return;
             }
-            const buildPath = this.outputPath;
+            const buildPath = FileLaneUtil_1.default.getOutputPath(this.context);
             return Promise.all(fileList.map((item) => {
                 const resolvePath = path_1.default.relative(this.context.projectPath, item.path);
                 // 将相对路径与输出路径拼接，形成最新的文件路径
@@ -253,26 +255,52 @@ 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) {
+            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);
+                }
+            }
+        });
+    }
+    /**
+     * 执行项目转换的前置工作
+     */
+    complyBeforeCompile(fileList) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { beforeCompile } = this.config;
+            if (beforeCompile) {
+                for (let item of beforeCompile) {
                     yield item(this.context, fileList, this.config, this.compilerOption);
                 }
             }
         });
     }
     /**
-     * 运行转换后续的任务
+     * 执行项目转换的后续工作
      */
-    runFollowWorks() {
+    complyAfterCompile() {
         return __awaiter(this, void 0, void 0, function* () {
-            const { followWorks } = this.config;
-            if (followWorks) {
-                for (let item of followWorks) {
+            const { afterCompile } = this.config;
+            if (afterCompile) {
+                for (let item of afterCompile) {
                     try {
                         shared_utils_1.ColorConsole.info(`FollowWork: ${item.workerDescribe} start`);
                         yield item.worker(this.context, this.config, this.compilerOption);
@@ -289,10 +317,11 @@ class FileLane {
     watch() {
         return __awaiter(this, void 0, void 0, function* () {
             // 监听文件变化，并触发 build
-            this.listenFileChange(() => __awaiter(this, void 0, void 0, function* () {
-                const fileList = this.collectFile();
+            const onChange = (changedFileList) => __awaiter(this, void 0, void 0, function* () {
+                const fileList = this.config.collectFile ? this.config.collectFile() : this.collectFile();
                 yield this.build(fileList);
-            }));
+            });
+            this.listenFileChange(onChange);
         });
     }
     /**
@@ -333,7 +362,7 @@ class FileLane {
         });
         const handler = (filePath) => {
             const { exclude, include } = this.config;
-            // 判断是否为删除，执行onChange回调
+            // 执行onChange回调
             if (shared_utils_1.FileUtil.include(filePath, include, exclude)) {
                 throttledOnChange([filePath]);
             }
@@ -365,16 +394,12 @@ class FileLane {
         }
         this.watcher = watcher;
     }
-    get outputPath() {
-        const { output, projectPath } = this.context;
-        return path_1.default.join(projectPath, output);
-    }
     /**
      * 清除输出文件夹
      */
     cleanOutput() {
         return __awaiter(this, void 0, void 0, function* () {
-            yield (0, del_1.default)(this.outputPath, { force: true });
+            yield (0, del_1.default)(FileLaneUtil_1.default.getOutputPath(this.context), { force: true });
         });
     }
     /**

package/lib/interface/IFileLaneConfig.d.ts

@@ -21,6 +21,16 @@ export interface IRule {
  * IFileLaneConfig
  */
 export default interface IFileLaneConfig<O = any> {
+    /**
+     * 项目文件采集器
+     *
+     * @param entryFileList 输入的文件列表
+     *
+     * @returns 返回项目中所有待处理的文件路径
+     *
+     * @description 用于采集所有要处理的真实文件路径列表，或者输入文件列表中要处理的真实文件路径列表
+     */
+    collectFile?: (entryFileList?: string[]) => string[];
     /**
      * 文件收集器
      *
@@ -68,21 +78,25 @@ export default interface IFileLaneConfig<O = any> {
      */
     plugins?: IPlugin[];
     /**
-     * 前置工作
-     *
-     * @param context 上下文
-     * @param fileList 待转换的文件列表
-     * @returns
+     * 启动阶段的准备工作
      */
-    preWorks?: PreWork[];
+    beforeWorks?: BeforeWork[];
     /**
-     * 转换结束后续的工作
+     * 收尾阶段的工作
+     */
+    afterWorks?: AfterWork[];
+    /**
+     * 项目转换的前置工作
+     */
+    beforeCompile?: PreWork[];
+    /**
+     * 项目转换的后续工作
      *
      * xts--[zip]
      * ux--[webpack, zip]
      * uxInspect--[webpack, zipPhone, zipWatch, zipTv]
      */
-    followWorks?: FollowWoker<O>[];
+    afterCompile?: FollowWoker<O>[];
     /**
      * 配置watch时忽略的文件或者文件夹
      */
@@ -93,5 +107,11 @@ type FollowWoker<O> = {
     workerDescribe?: 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>;
+/**
+ * context 上下文
+ * fileList 待转换的文件列表
+ */
+export type PreWork<O = any> = (context: IFileLaneContext, fileList: string[], config: IFileLaneConfig, compilerOption: O) => Promise<any>;
+export type BeforeWork = (context: IFileLaneContext) => Promise<any>;
+export type AfterWork = (context: IFileLaneContext) => Promise<any>;
 export {};

package/lib/utils/FileLaneUtil.d.ts

@@ -13,5 +13,6 @@ declare class FileLaneUtil {
     static pathToFileParam(path: string, readContent?: boolean): IFileParam;
     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

@@ -5,6 +5,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 const shared_utils_1 = require("@aiot-toolkit/shared-utils");
 const fs_extra_1 = __importDefault(require("fs-extra"));
+const path_1 = __importDefault(require("path"));
 /**
  * FileLaneUtil
  */
@@ -49,5 +50,9 @@ class FileLaneUtil {
             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-beta.13",
+  "version": "2.0.2-beta.14",
   "description": "File conversion tool, can be one-to-one, one to N, N to one",
   "keywords": [
     "file",
@@ -20,15 +20,14 @@
     "test": "node ./__tests__/file-lane.test.js"
   },
   "dependencies": {
-    "@aiot-toolkit/shared-utils": "2.0.2-beta.13",
-    "chokidar": "^3.5.3",
+    "@aiot-toolkit/shared-utils": "2.0.2-beta.14",
+    "chokidar": "^3.6.0",
     "del": "^4.1.0",
     "fs-extra": "^11.2.0",
     "lodash": "^4.17.21"
   },
   "devDependencies": {
-    "@types/archiver": "^5.3.2",
     "@types/fs-extra": "^11.0.4"
   },
-  "gitHead": "30bf14ae958b66937da1b79dcfcd7c436e08af50"
+  "gitHead": "c6093733d0267d2d1359fec0af8f7a253955e3e3"
 }