file-lane 2.0.2-beta.1 → 2.0.2-beta.11

package/lib/FileLane.d.ts

@@ -9,17 +9,19 @@ import IFileLaneConfig from './interface/IFileLaneConfig';
 declare class FileLane<O = any> {
     readonly config: IFileLaneConfig<O>;
     readonly compilerOption?: O | undefined;
+    private readonly events?;
     private context;
     private watcher?;
     private compilation?;
-    private ws;
     /**
      * 实例化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?: {
+        onBuildSuccess?: (() => void) | undefined;
+    } | undefined);
     /**
      * 运行
      * @param params
@@ -79,5 +81,11 @@ declare class FileLane<O = any> {
      * 清除输出文件夹
      */
     private cleanOutput;
+    /**
+     * 1. 配置的忽略文件夹
+     * 2. 默认应该忽略的文件及文件夹
+     * @returns
+     */
+    private getIgnoreConfig;
 }
 export default FileLane;

package/lib/FileLane.js

@@ -13,13 +13,11 @@ 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 del_1 = __importDefault(require("del"));
 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"));
@@ -38,9 +36,10 @@ 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.processExitHandler = () => {
             this.dispose();
         };
@@ -56,10 +55,10 @@ 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.cleanOutput();
             const fileList = this.collectFile();
             if (!fileList || !fileList.length) {
                 return;
@@ -132,6 +131,7 @@ class FileLane {
      */
     build(fileList) {
         return __awaiter(this, void 0, void 0, function* () {
+            const { onBuildSuccess } = this.events || {};
             this.initCompilation();
             try {
                 yield this.runPreWorks(fileList);
@@ -146,14 +146,17 @@ class FileLane {
                 this.triggerPlugins(new CompilationEvent_1.default(CompilationEvent_1.default.FLLOW_WORK_START));
                 yield this.runFollowWorks();
                 this.triggerPlugins(new CompilationEvent_1.default(CompilationEvent_1.default.FLLOW_WORK_END));
-                ColorConsole_1.default.success({
+                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)
                 });
+                onBuildSuccess === null || onBuildSuccess === void 0 ? void 0 : onBuildSuccess();
             }
             catch (error) {
-                console.log('error', error);
-                ColorConsole_1.default.throw(`ERROR: build error, ${error || 'unknown error'}`);
+                console.log('FileLane error', error);
+                shared_utils_1.ColorConsole.throw(`ERROR: `, { word: 'build error' }, `, ${error || 'unknown error'}`);
+                // 结束任务
+                process.exit();
             }
         });
     }
@@ -234,8 +237,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);
             }
@@ -257,13 +260,7 @@ class FileLane {
             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');
-                    }
+                    yield item(this.context, fileList, this.config, this.compilerOption);
                 }
             }
         });
@@ -276,7 +273,15 @@ class FileLane {
             const { followWorks } = this.config;
             if (followWorks) {
                 for (let item of followWorks) {
-                    yield item(this.context, this.config, this.compilerOption);
+                    try {
+                        shared_utils_1.ColorConsole.info(`FollowWork: ${item.workerDescribe} start`);
+                        yield item.worker(this.context, this.config, this.compilerOption);
+                        shared_utils_1.ColorConsole.info(`FollowWork: ${item.workerDescribe} end`);
+                    }
+                    catch (error) {
+                        shared_utils_1.ColorConsole.throw(`FollowWork: ${item.workerDescribe} error, ${error}`);
+                        process.exit();
+                    }
                 }
             }
         });
@@ -285,16 +290,8 @@ class FileLane {
         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'
-                }));
             }));
         });
     }
@@ -308,8 +305,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 +315,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,7 +325,7 @@ 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,
@@ -337,13 +334,13 @@ class FileLane {
         const handler = (filePath) => {
             const { exclude, include } = this.config;
             // 判断是否为删除，执行onChange回调
-            if (FileUtil_1.default.include(filePath, include, exclude)) {
+            if (shared_utils_1.FileUtil.include(filePath, include, exclude)) {
                 throttledOnChange([filePath]);
             }
         };
         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) => {
                 // 监听文件添加事件
@@ -361,6 +358,7 @@ class FileLane {
             .on('error', (error) => {
             // 监听错误
             FileLaneUtil_1.default.checkError(error.message);
+            watcher.close();
         });
         if (this.watcher) {
             this.watcher.close();
@@ -375,7 +373,31 @@ class FileLane {
      * 清除输出文件夹
      */
     cleanOutput() {
-        fs_extra_1.default.removeSync(this.outputPath);
+        return __awaiter(this, void 0, void 0, function* () {
+            yield (0, del_1.default)(this.outputPath, { force: true });
+        });
+    }
+    /**
+     * 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/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/IFileLaneConfig.d.ts

@@ -1,10 +1,22 @@
-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';
 export type ILoaderClass = (new (...args: any[]) => ILoader) & {
     raw?: boolean;
 };
+export interface IRule {
+    /**
+     * 配置文件
+     */
+    test: MatchType;
+    /**
+     * 文件的 Loader，从前向后依次执行，前一个 loader 结果做为后一个 loader 的入参
+     */
+    loader: ILoaderClass[];
+    exclude?: MatchType;
+    include?: MatchType;
+}
 /**
  * IFileLaneConfig
  */
@@ -45,15 +57,7 @@ export default interface IFileLaneConfig<O = any> {
         /**
          * 转换规则
          */
-        rules: {
-            /**
-             * 配置文件
-             */
-            test: MatchType;
-            loader: ILoaderClass[];
-            exclude?: MatchType;
-            include?: MatchType;
-        }[];
+        rules: IRule[];
     };
     /**
      * 插件
@@ -78,11 +82,16 @@ export default interface IFileLaneConfig<O = any> {
      * ux--[webpack, zip]
      * uxInspect--[webpack, zipPhone, zipWatch, zipTv]
      */
-    followWorks?: FollowWork<O>[];
+    followWorks?: FollowWoker<O>[];
     /**
      * 配置watch时忽略的文件或者文件夹
      */
     watchIgnores?: MatchType;
 }
+type FollowWoker<O> = {
+    worker: FollowWork<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>;
+export {};

package/lib/utils/FileLaneUtil.d.ts

@@ -11,13 +11,6 @@ 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;
 }

package/lib/utils/FileLaneUtil.js

@@ -1,22 +1,10 @@
 "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"));
 /**
  * FileLaneUtil
  */
@@ -40,49 +28,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 +38,16 @@ 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}`);
+        }
     }
 }
 exports.default = FileLaneUtil;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "file-lane",
-  "version": "2.0.2-beta.1",
+  "version": "2.0.2-beta.11",
   "description": "File conversion tool, can be one-to-one, one to N, N to one",
   "keywords": [
     "file",
@@ -20,13 +20,15 @@
     "test": "node ./__tests__/file-lane.test.js"
   },
   "dependencies": {
-    "@aiot-toolkit/shared-utils": "2.0.2-beta.1",
-    "archiver": "^6.0.1",
+    "@aiot-toolkit/shared-utils": "2.0.2-beta.11",
     "chokidar": "^3.5.3",
+    "del": "^4.1.0",
     "lodash": "^4.17.21"
   },
   "devDependencies": {
-    "@types/archiver": "^5.3.2"
+    "@types/archiver": "^5.3.2",
+    "@types/fs-extra": "^11.0.4",
+    "fs-extra": "^11.2.0"
   },
-  "gitHead": "9244af36e617295ea4ff11a2f4f07f0e4f9f5f59"
+  "gitHead": "07c38dd12ba0d932c6dc1fd16fe25aaf15ab9fbb"
 }