file-lane 2.0.5-widget-provider-beta.2 → 2.0.5

package/README.md

@@ -1,247 +1,247 @@
-# 项目介绍
-
-file-lane模块用于文件转换，可实现文件1对1的转换，也可实现1对多、多对1的文件转换。
-
-<img src="./doc/flow-detail.png" style="max-width: 1000px; width: 100%"/>
-
-## 安装使用
-
-- 安装
-
-  `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
-}
-```
-
-示例:
-
-```
-{
-  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
-```
-
-示例:
-
-```javascript
-watchIgnores = [/node_modules/, '/build/', '/dist/']
-```
+# 项目介绍
+
+file-lane模块用于文件转换，可实现文件1对1的转换，也可实现1对多、多对1的文件转换。
+
+<img src="./doc/flow-detail.png" style="max-width: 1000px; width: 100%"/>
+
+## 安装使用
+
+- 安装
+
+  `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
+}
+```
+
+示例:
+
+```
+{
+  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
+```
+
+示例:
+
+```javascript
+watchIgnores = [/node_modules/, '/build/', '/dist/']
+```

package/lib/FileLane.js

@@ -15,31 +15,31 @@ var _FileLaneUtil = _interopRequireDefault(require("./utils/FileLaneUtil"));
 var _IChangedFile = require("./interface/IChangedFile");
 var _FileLaneTriggerType = _interopRequireDefault(require("./enum/FileLaneTriggerType"));
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
-/**
- * FileLane
- *
- * 文件车道，用于将文件进行对应转换，支持1对1、1对N、N对1
- *
- * @example
- * ```
- * new FileLane<IJavascriptCompileOption>(
- * fileLaneConfig,
- * projectPath,
- * compilerOption,
- * {
- *   onBuildSuccess: (data) => {},
- *   onBuildError: (data) => {},
- *   onLog: (logs) => {}
- * }).start()
- * ```
- *
- * @description
+/**
+ * FileLane
+ *
+ * 文件车道，用于将文件进行对应转换，支持1对1、1对N、N对1
+ *
+ * @example
+ * ```
+ * new FileLane<IJavascriptCompileOption>(
+ * fileLaneConfig,
+ * projectPath,
+ * compilerOption,
+ * {
+ *   onBuildSuccess: (data) => {},
+ *   onBuildError: (data) => {},
+ *   onLog: (logs) => {}
+ * }).start()
+ * ```
+ *
+ * @description
  */
 class FileLane {
   // 创建监听实例
 
-  /**
-   * 每次编译的数据对象
+  /**
+   * 每次编译的数据对象
    */
 
   changeFileList = [];
@@ -48,12 +48,12 @@ class FileLane {
   nextBuildParam = null;
   fileHashCache = {};
 
-  /**
-   * 实例化FileLane
-   * @param config fileLane 配置
-   * @param projectPath 项目路径
-   * @param compilerOption 编译参数，不同语言的项目具有的参数不同，即使同一项目开发者也会设置不同的参数
-   * @param events 事件监听器
+  /**
+   * 实例化FileLane
+   * @param config fileLane 配置
+   * @param projectPath 项目路径
+   * @param compilerOption 编译参数，不同语言的项目具有的参数不同，即使同一项目开发者也会设置不同的参数
+   * @param events 事件监听器
    */
   constructor(config, projectPath, compilerOption, events) {
     this.config = config;
@@ -67,10 +67,10 @@ class FileLane {
     process.on('SIGINT', this.sigintHandler);
   }
 
-  /**
-   * 运行
-   * @param params
-   * @returns
+  /**
+   * 运行
+   * @param params
+   * @returns
    */
   async start(params) {
     const errorList = this.validateConfig();
@@ -156,11 +156,11 @@ class FileLane {
     await this.cleanOutput();
   }
 
-  /**
-   * 触发编译
-   *
-   * 如果：在编译过程中，则记录统参数，待本次 build 完成后，开始下一次
-   * 否则：直接触发编译
+  /**
+   * 触发编译
+   *
+   * 如果：在编译过程中，则记录统参数，待本次 build 完成后，开始下一次
+   * 否则：直接触发编译
    */
   async triggerBuild(param) {
     if (this.building) {
@@ -170,9 +170,9 @@ class FileLane {
     }
   }
 
-  /**
-   *
-   * @param fileList 原始文件列表
+  /**
+   *
+   * @param fileList 原始文件列表
    */
   async build(param) {
     const {
@@ -281,13 +281,13 @@ class FileLane {
     return result;
   }
 
-  /**
-   * 处理日志
-   * 1. 触发onLog事件
-   * 2. 如果有错误日志，则抛出错误
-   * @param logs
-   * @param onError
-   * @returns
+  /**
+   * 处理日志
+   * 1. 触发onLog事件
+   * 2. 如果有错误日志，则抛出错误
+   * @param logs
+   * @param onError
+   * @returns
    */
   handlerLogs(logs, onError) {
     if (!logs?.length) {
@@ -329,10 +329,10 @@ class FileLane {
     return loader.parser(fileList);
   }
 
-  /**
-   * 匹配符合条件的loader
-   * @param filePath
-   * @returns
+  /**
+   * 匹配符合条件的loader
+   * @param filePath
+   * @returns
    */
   findLoader(filePath) {
     const parse = _path.default.basename(filePath);
@@ -353,8 +353,8 @@ class FileLane {
     }
   }
 
-  /**
-   * start开始时的准备工作
+  /**
+   * start开始时的准备工作
    */
   async complyBeforeWorks() {
     const {
@@ -367,8 +367,8 @@ class FileLane {
     }
   }
 
-  /**
-   * start结束后的收尾工作
+  /**
+   * start结束后的收尾工作
    */
   async complyAfterWork() {
     const {
@@ -381,8 +381,8 @@ class FileLane {
     }
   }
 
-  /**
-   * 执行项目转换的前置工作
+  /**
+   * 执行项目转换的前置工作
    */
   async complyBeforeCompile() {
     const {
@@ -400,8 +400,8 @@ class FileLane {
     }
   }
 
-  /**
-   * 执行项目转换的后续工作
+  /**
+   * 执行项目转换的后续工作
    */
   async complyAfterCompile() {
     const {
@@ -443,10 +443,10 @@ class FileLane {
     this.listenFileChange(onChange);
   }
 
-  /**
-   * 采集所有要处理的真实文件路径列表
-   * @param entryFileList
-   * @returns
+  /**
+   * 采集所有要处理的真实文件路径列表
+   * @param entryFileList
+   * @returns
    */
   collectFile(entryFileList) {
     // 使用include  projectPath获取所有要处理的真实文件
@@ -467,9 +467,9 @@ class FileLane {
     return files;
   }
 
-  /**
-   * 监听文件变化
-   * @param onChange
+  /**
+   * 监听文件变化
+   * @param onChange
    */
   listenFileChange(onChange) {
     const watcher = _chokidar.default.watch(this.context.projectPath, {
@@ -512,16 +512,16 @@ class FileLane {
     this.watcher = watcher;
   }
 
-  /**
-   * 清除输出文件夹
+  /**
+   * 清除输出文件夹
    */
   async cleanOutput() {
     return _sharedUtils.FileUtil.del(_FileLaneUtil.default.getOutputPath(this.context));
   }
-  /**
-   * 1. 配置的忽略文件夹
-   * 2. 默认应该忽略的文件及文件夹
-   * @returns
+  /**
+   * 1. 配置的忽略文件夹
+   * 2. 默认应该忽略的文件及文件夹
+   * @returns
    */
   getIgnoreConfig() {
     let ignoreList = [];

package/lib/FileLaneCompilation.d.ts

@@ -1,11 +1,10 @@
 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>[];
+    buildFileList: string[];
     /**
      * 触发方式
      *

package/lib/FileLaneCompilation.js

@@ -7,19 +7,19 @@ exports.default = void 0;
 var _FileLaneTriggerType = _interopRequireDefault(require("./enum/FileLaneTriggerType"));
 var _AsyncEventDispatcher = _interopRequireDefault(require("./event/asyncEvent/AsyncEventDispatcher"));
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
-/**
- * FileLaneCompilation
+/**
+ * FileLaneCompilation
  */
 class FileLaneCompilation extends _AsyncEventDispatcher.default {
   buildFileList = [];
-  /**
-   * 触发方式
-   *
+  /**
+   * 触发方式
+   *
    */
   trigger = (() => _FileLaneTriggerType.default.START)();
 
-  /**
-   * 触发次数
+  /**
+   * 触发次数
    */
   triggerCount = 0;
   info = (() => ({

package/lib/enum/FileLaneTriggerType.js

@@ -4,8 +4,8 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
-/**
- * FileLaneTriggerType
+/**
+ * FileLaneTriggerType
  */
 var FileLaneTriggerType = /*#__PURE__*/function (FileLaneTriggerType) {
   FileLaneTriggerType[FileLaneTriggerType["START"] = 1] = "START";

package/lib/event/CompilationEvent.js

@@ -6,8 +6,8 @@ Object.defineProperty(exports, "__esModule", {
 exports.default = void 0;
 var _DataEvent = _interopRequireDefault(require("./asyncEvent/DataEvent"));
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
-/**
- * CompilationEvent
+/**
+ * CompilationEvent
  */
 class CompilationEvent extends _DataEvent.default {
   static PROJECT_START = 'PROJECT_START';

package/lib/event/FileEvent.js

@@ -6,8 +6,8 @@ Object.defineProperty(exports, "__esModule", {
 exports.default = void 0;
 var _DataEvent = _interopRequireDefault(require("./asyncEvent/DataEvent"));
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
-/**
- * FileEvent
+/**
+ * FileEvent
  */
 class FileEvent extends _DataEvent.default {
   static FILE_END_COMPILATION = 'FILE_END_COMPILATION';

package/lib/event/asyncEvent/DataEvent.js

@@ -4,8 +4,8 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
-/**
- * DataEvent
+/**
+ * DataEvent
  */
 class DataEvent {
   constructor(type, data) {

package/lib/utils/FileLaneUtil.js

@@ -8,15 +8,15 @@ var _sharedUtils = require("@aiot-toolkit/shared-utils");
 var _fsExtra = _interopRequireDefault(require("fs-extra"));
 var _path = _interopRequireDefault(require("path"));
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
-/**
- * FileLaneUtil
+/**
+ * FileLaneUtil
  */
 class FileLaneUtil {
-  /**
-   * 文件路径转换为文件参数
-   * @param path 路径
-   * @param readContent 是否读取文件内容以设置 content 的值，默认 false
-   * @returns
+  /**
+   * 文件路径转换为文件参数
+   * @param path 路径
+   * @param readContent 是否读取文件内容以设置 content 的值，默认 false
+   * @returns
    */
   static pathToFileParam(path) {
     let readContent = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : false;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "file-lane",
-  "version": "2.0.5-widget-provider-beta.2",
+  "version": "2.0.5",
   "description": "File conversion tool, can be one-to-one, one to N, N to one",
   "keywords": [
     "file",
@@ -20,12 +20,12 @@
     "test": "node ./__tests__/file-lane.test.js"
   },
   "dependencies": {
-    "@aiot-toolkit/shared-utils": "2.0.5-widget-provider-beta.2",
+    "@aiot-toolkit/shared-utils": "2.0.5",
     "chokidar": "^3.6.0",
     "fs-extra": "^11.2.0"
   },
   "devDependencies": {
     "@types/fs-extra": "^11.0.4"
   },
-  "gitHead": "4a8894bc66a9c78cd835ed6c1af74d054300e064"
+  "gitHead": "deb83e8b8fa65191a286690efe3d957d7df772f4"
 }