@hadss/hmrouter-plugin 1.0.0-rc.3 → 1.0.0-rc.5

package/README.md

@@ -4,34 +4,37 @@
 ```json5
 {
   "dependencies": {
-    "@hadss/hmrouter-plugin": "^1.0.0-rc.0" // 使用npm仓版本号
+    "@hadss/hmrouter-plugin": "^1.0.0-rc.4" // 使用npm仓版本号
   },
   // ...其他配置
 }
 ```
 
-2. 项目根目录或者模块目录创建路由编译插件配置文件`hmrouter_config.json`（推荐）
-```json5
-{
-  "scanDir": ["src/main/ets/components","src/main/ets/interceptors"],
-  // 如果不传则扫描src/main/ets目录，对代码进行全量扫描，建议配置可缩短编译耗时
-  "saveGeneratedFile": false, // 默认为false，改成true则不删除编译产物
-}
-```
-
-3. 在模块中引入路由编译插件，修改`hvigorfile.ts`
+2. 在模块中引入路由编译插件，修改`hvigorfile.ts`
 ```typescript
 import { hapTasks } from '@ohos/hvigor-ohos-plugin';
-import { hapPlugin } from "@hadss/hmrouter-plugin";
+import { hapPlugin } from '@hadss/hmrouter-plugin';
 
 export default {
   system: hapTasks,
-  plugins: [hapPlugin()]
+  plugins: [hapPlugin()] // 使用HMRouter框架中标签的模块均需要配置，与模块类型保持一致
+}
+```
+
+> 如果模块是Har则使用`harPlugin()`, 模块是Hsp则使用`hspPlugin()`
+
+3. 项目根目录或者模块目录创建路由编译插件配置文件`hmrouter_config.json`（推荐）
+```json5
+{
+  // 如果不配置则扫描src/main/ets目录，对代码进行全量扫描，如果配置则数组不能为空，建议配置指定目录可缩短编译耗时
+  "scanDir": ["src/main/ets/components","src/main/ets/interceptors"],
+  "saveGeneratedFile": false, // 默认为false，调试排除错误时可以改成true，不删除编译产物
 }
 ```
 
-> 如果是Har则使用`harPlugin()`, Hsp则使用`hspPlugin()`
- 
+> 配置文件读取规则为 模块 > 工程 > 默认
+> 优先使用本模块内的配置，如果没有配置，则找模块目录的上级目录(最多找三层目录，找到则停止)，若找不到则使用默认配置
+
 ## HMRouter使用
 
 详见[@hadss/hmrouter](https://ohpm.openharmony.cn/#/cn/detail/@hadss%2Fhmrouter)

package/dist/HMRouterAnalyzer.d.ts

@@ -0,0 +1,40 @@
+import { HMRouterPluginConfig } from './HMRouterPluginConfig';
+import { AnalyzerResultLike } from './common/PluginModel';
+export declare class Analyzer {
+    analyzeResultSet: Set<AnalyzerResultLike>;
+    private readonly sourcePath;
+    private readonly pluginConfig;
+    private analyzeResult;
+    private classMethodAnalyzeResult;
+    private keywordPos;
+    private importMap;
+    constructor(sourcePath: string, pluginConfig: HMRouterPluginConfig);
+    start(): void;
+    private resolveNode;
+    private resolveImportDeclaration;
+    private resolveMissingDeclaration;
+    private isDecoratedClass;
+    private resolveClass;
+    private resolveClassMethod;
+    private resolveDecorator;
+    private switchIdentifier;
+    private resolveCallExpression;
+    private resolveExpression;
+    private resolveBlock;
+    private parseAnnotation;
+    private parseConfig;
+    private resolvePropertyAccess;
+    private resolveIdentifier;
+    private resolveArrayLiteral;
+    private resolveNumericLiteral;
+    private resolveStringLiteral;
+    private resolveTrueKeyword;
+    private resolveFalseKeyword;
+    private getSourceFile;
+    private findConstantValueInSourceFile;
+    private findObjectValueInSourceFile;
+    private resolveConstantValue;
+    private resolveObjectValue;
+    private resolvePath;
+    private parseVariableDeclaration;
+}

package/{lib → dist}/HMRouterAnalyzer.js

@@ -1,18 +1,4 @@
 "use strict";
-/*
- * Copyright (c) 2024 Huawei Device Co., Ltd.
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
@@ -46,7 +32,6 @@ class Analyzer {
                 this.analyzeResultSet = new Set([...this.analyzeResultSet, ...this.classMethodAnalyzeResult]);
             }
         });
-        // 遍历map查看是否还有常量类型的属性值
         this.analyzeResultSet.forEach(value => {
             if (value.annotation === 'HMRouter') {
                 let hmRouterResult = value;
@@ -54,7 +39,8 @@ class Analyzer {
                     hmRouterResult.pageUrl = this.resolveConstantValue(hmRouterResult.pageUrl.value);
                 }
                 else if (hmRouterResult.pageUrl.type === 'object') {
-                    hmRouterResult.pageUrl = this.resolveObjectValue(hmRouterResult.pageUrl.className, hmRouterResult.pageUrl.propertyName);
+                    hmRouterResult.pageUrl =
+                        this.resolveObjectValue(hmRouterResult.pageUrl.className, hmRouterResult.pageUrl.propertyName);
                 }
             }
         });
@@ -110,6 +96,7 @@ class Analyzer {
                 variableArr.push(child.name.escapedText);
             }
         });
+        variableArr.push(node.importClause?.name?.text);
         let key = node.moduleSpecifier;
         if (typescript_1.default.isModuleName(key)) {
             this.importMap.set(key.text, variableArr);
@@ -120,14 +107,11 @@ class Analyzer {
         node.forEachChild(child => this.resolveNode(child));
     }
     isDecoratedClass(node) {
-        // @ts-ignore
         return node.modifiers?.some((item) => Constant_1.HMRouterPluginConstant.CLASS_ANNOTATION_ARR.includes(item.expression?.expression?.text));
     }
     resolveClass(node) {
-        // 解析到类声明，先清空一次返回结果
         this.analyzeResult = {};
         node.modifiers?.forEach(modifier => {
-            // 遍历分析装饰器
             this.resolveNode(modifier);
         });
         if (this.analyzeResult.annotation) {
@@ -142,7 +126,6 @@ class Analyzer {
                 member.modifiers?.forEach((modifier) => {
                     this.resolveNode(modifier);
                 });
-                // @ts-ignore
                 this.analyzeResult.functionName = member.name?.text;
                 this.analyzeResult.name = node.name?.text;
                 if (this.analyzeResult.annotation) {
@@ -204,13 +187,13 @@ class Analyzer {
         if (propertyName === 'pageUrl') {
             if (node.initializer.kind === typescript_1.default.SyntaxKind.Identifier) {
                 propertyValue = {
-                    type: 'constant', // 常量
+                    type: 'constant',
                     value: this.resolveNode(node.initializer)?.value
                 };
             }
             else if (node.initializer.kind === typescript_1.default.SyntaxKind.PropertyAccessExpression) {
                 propertyValue = {
-                    type: 'object', // 对象
+                    type: 'object',
                     className: this.resolveNode(node.initializer.expression)?.value,
                     propertyName: this.resolveNode(node.initializer.name)?.value
                 };
@@ -281,7 +264,7 @@ class Analyzer {
                 }
             });
         });
-        return nodeInfo.value['value'] !== '' ? nodeInfo : null;
+        return nodeInfo;
     }
     findObjectValueInSourceFile(sourceFile, className, propertyName) {
         let info = new NodeInfo();
@@ -290,37 +273,36 @@ class Analyzer {
                 return;
             }
             node.members.forEach(member => {
-                // @ts-ignore
                 if (member.name?.escapedText.toString() === propertyName) {
                     info = this.parseVariableDeclaration(member);
                 }
             });
         });
-        return info.value['value'] !== '' ? info : null;
+        return info;
     }
     resolveConstantValue(constantName) {
         const sourceFile = this.getSourceFile(this.resolvePath(constantName));
         if (!sourceFile) {
             return null;
         }
-        const nodeInfo = this.findConstantValueInSourceFile(sourceFile, constantName);
-        if (!nodeInfo) {
+        const constantValueStr = this.findConstantValueInSourceFile(sourceFile, constantName).value['value'];
+        if (!constantValueStr) {
             Logger_1.Logger.error(Logger_1.PluginError.ERR_NOT_EMPTY_STRING, constantName);
             throw new Error('constant value cannot be an empty string');
         }
-        return nodeInfo.value['value'];
+        return constantValueStr;
     }
     resolveObjectValue(className, propertyName) {
         const sourceFile = this.getSourceFile(this.resolvePath(className));
         if (!sourceFile) {
             return null;
         }
-        const info = this.findObjectValueInSourceFile(sourceFile, className, propertyName);
-        if (!info) {
+        const objectValueStr = this.findObjectValueInSourceFile(sourceFile, className, propertyName).value['value'];
+        if (!objectValueStr) {
             Logger_1.Logger.error(Logger_1.PluginError.ERR_NOT_EMPTY_STRING, propertyName);
             throw new Error('constant value cannot be an empty string');
         }
-        return info.value['value'];
+        return objectValueStr;
     }
     resolvePath(variableName) {
         let filePath = '';
@@ -342,10 +324,13 @@ class Analyzer {
     parseVariableDeclaration(node) {
         let variableName = this.resolveNode(node.name)?.value;
         let variableValue = this.resolveNode(node.initializer)?.value;
+        if (typeof variableValue !== 'string') {
+            Logger_1.Logger.error(Logger_1.PluginError.ERR_INVALID_STRING_VALUE, variableName);
+            throw new Error('Invalid constant value');
+        }
         let info = new NodeInfo();
         info.value = { key: variableName, value: variableValue };
         return info;
     }
 }
 exports.Analyzer = Analyzer;
-//# sourceMappingURL=HMRouterAnalyzer.js.map

package/dist/HMRouterHvigorPlugin.d.ts

@@ -0,0 +1,15 @@
+import { HMRouterPluginConfig } from './HMRouterPluginConfig';
+import { RouterInfo } from './common/PluginModel';
+export declare class HMRouterHvigorPlugin {
+    config: HMRouterPluginConfig;
+    routerMap: RouterInfo[];
+    private scanFiles;
+    private HMRouterNum;
+    constructor(config: HMRouterPluginConfig);
+    analyzeAnnotation(): void;
+    private pushRouterInfo;
+    private generateBuilder;
+    generateRouterMap(): void;
+    private deepScan;
+    private stringToHashCode;
+}

package/{lib → dist}/HMRouterHvigorPlugin.js

@@ -1,32 +1,16 @@
 "use strict";
-/*
- * Copyright (c) 2024 Huawei Device Co., Ltd.
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.HMRouterHvigorPlugin = void 0;
 const fs_1 = __importDefault(require("fs"));
-const path_1 = __importDefault(require("path"));
 const handlebars_1 = __importDefault(require("handlebars"));
 const hvigor_1 = require("@ohos/hvigor");
 const PluginModel_1 = require("./common/PluginModel");
 const HMRouterAnalyzer_1 = require("./HMRouterAnalyzer");
 const Logger_1 = require("./common/Logger");
 const Constant_1 = require("./common/Constant");
-// 定义HMRouterHvigorPlugin类
 class HMRouterHvigorPlugin {
     constructor(config) {
         this.routerMap = [];
@@ -35,40 +19,33 @@ class HMRouterHvigorPlugin {
         this.config = config;
     }
     analyzeAnnotation() {
-        this.config.scanDir.forEach(scanDir => {
-            const scanPath = hvigor_1.FileUtil.pathResolve(this.config.modulePath, scanDir);
+        this.config.scanDir.forEach((dir) => {
+            const scanPath = this.config.getScanPath(dir);
             this.deepScan(scanPath, '');
         });
         Logger_1.Logger.info(`Scanned ${this.scanFiles.length} files`, this.scanFiles);
-        this.scanFiles.forEach(filePath => {
+        this.scanFiles.forEach((filePath) => {
             if (filePath.endsWith(Constant_1.HMRouterPluginConstant.VIEW_NAME_SUFFIX)) {
-                // 创建Analyzer对象
                 const analyzer = new HMRouterAnalyzer_1.Analyzer(filePath, this.config);
-                // 开始分析
                 analyzer.start();
-                // 遍历分析结果
                 for (let analyzeResult of analyzer.analyzeResultSet) {
                     analyzeResult.module = this.config.moduleName;
-                    let pageSourceFile = path_1.default.relative(this.config.modulePath, filePath);
+                    let pageSourceFile = this.config.getRelativeSourcePath(filePath);
                     this.pushRouterInfo(analyzeResult, pageSourceFile.replaceAll(Constant_1.HMRouterPluginConstant.FILE_SEPARATOR, Constant_1.HMRouterPluginConstant.DELIMITER));
                 }
                 this.HMRouterNum = 0;
             }
         });
     }
-    // 推送路由信息
     pushRouterInfo(analyzeResult, pageSourceFile) {
-        // 判断注解类型
         switch (analyzeResult.annotation) {
             case Constant_1.HMRouterPluginConstant.ROUTER_ANNOTATION:
                 this.HMRouterNum++;
-                // 判断是否存在多个HMRouter注解
                 if (this.HMRouterNum > 1) {
                     Logger_1.Logger.error(Logger_1.PluginError.ERR_REPEAT_ANNOTATION, pageSourceFile);
                     throw new Error(`文件${pageSourceFile}中存在多个HMRouter注解`);
                 }
                 let [generatorFilePath, componentName] = this.generateBuilder(analyzeResult, pageSourceFile);
-                // window环境下需要替换路径中的反斜杠
                 generatorFilePath = generatorFilePath.replaceAll(Constant_1.HMRouterPluginConstant.FILE_SEPARATOR, Constant_1.HMRouterPluginConstant.DELIMITER);
                 this.routerMap.push(new PluginModel_1.RouterInfo(analyzeResult.pageUrl, generatorFilePath, `${componentName}Builder`, analyzeResult));
                 break;
@@ -90,38 +67,26 @@ class HMRouterHvigorPlugin {
                 break;
         }
     }
-    // 生成Builder
     generateBuilder(analyzeResult, pageSourceFile) {
-        // 获取导入路径
-        let importPath = path_1.default
-            .relative(this.config.builderDir, pageSourceFile)
+        let importPath = this.config
+            .getRelativeBuilderPath(pageSourceFile)
             .replaceAll(Constant_1.HMRouterPluginConstant.FILE_SEPARATOR, Constant_1.HMRouterPluginConstant.DELIMITER)
             .replaceAll(Constant_1.HMRouterPluginConstant.VIEW_NAME_SUFFIX, '');
-        // 生成视图名称
         let generatorViewName = Constant_1.HMRouterPluginConstant.VIEW_NAME_PREFIX + analyzeResult.name + this.stringToHashCode(analyzeResult.pageUrl);
-        // 创建模板模型
         const templateModel = new PluginModel_1.TemplateModel(analyzeResult.pageUrl, importPath, analyzeResult.name, !!analyzeResult.dialog, generatorViewName);
-        // 获取模板文件路径
-        const templateFilePath = hvigor_1.FileUtil.pathResolve(__dirname, Constant_1.HMRouterPluginConstant.PARENT_DELIMITER + this.config.builderTpl);
-        // 读取模板文件
+        const templateFilePath = this.config.getTplFilePath();
         const tpl = hvigor_1.FileUtil.readFileSync(templateFilePath).toString();
-        // 编译模板
         const template = handlebars_1.default.compile(tpl);
-        // 渲染模板
         const output = template(templateModel);
-        // 获取生成文件路径
-        const generatorFilePath = hvigor_1.FileUtil.pathResolve(this.config.modulePath, this.config.builderDir, templateModel.generatorViewName + Constant_1.HMRouterPluginConstant.VIEW_NAME_SUFFIX);
+        const generatorFilePath = this.config.getGeneratedFilePath(templateModel.generatorViewName);
         hvigor_1.FileUtil.ensureFileSync(generatorFilePath);
         hvigor_1.FileUtil.writeFileSync(generatorFilePath, output);
         Logger_1.Logger.info(`Builder ${templateModel.generatorViewName}.ets has been generated in ${generatorFilePath}`);
-        // 返回生成文件路径和组件名称
-        return [path_1.default.join(this.config.builderDir, templateModel.generatorViewName + Constant_1.HMRouterPluginConstant.VIEW_NAME_SUFFIX), templateModel.componentName];
+        return [this.config.getBuilderFilePath(templateModel.generatorViewName), templateModel.componentName];
     }
-    // 生成路由表文件
     generateRouterMap() {
         let set = new Set();
-        this.routerMap.forEach(item => {
-            // 判断路由名称是否重复
+        this.routerMap.forEach((item) => {
             if (set.has(item.name)) {
                 Logger_1.Logger.error(Logger_1.PluginError.ERR_DUPLICATE_NAME, item.name);
                 throw new Error(`路由${item.name}重复`);
@@ -131,28 +96,24 @@ class HMRouterHvigorPlugin {
             }
         });
         let routerMap = {
-            routerMap: this.routerMap.map(item => {
-                // 删除注解
+            routerMap: this.routerMap.map((item) => {
                 if (item.customData && item.customData.annotation) {
                     delete item.customData.annotation;
                 }
                 return item;
-            })
+            }),
         };
-        // 获取路由映射文件路径
         const routerMapJsonStr = JSON.stringify(routerMap, null, 2);
-        const routerMapFilePath = hvigor_1.FileUtil.pathResolve(this.config.modulePath, this.config.routerMapDir, Constant_1.HMRouterPluginConstant.ROUTER_MAP_NAME);
-        // 确保文件存在
+        const routerMapFilePath = this.config.getRouterMapDir();
         hvigor_1.FileUtil.ensureFileSync(routerMapFilePath);
         hvigor_1.FileUtil.writeFileSync(routerMapFilePath, routerMapJsonStr);
         Logger_1.Logger.info(`hm_router_map.json has been generated in ${routerMapFilePath}`);
     }
-    // 深度扫描文件夹获取需要扫描的文件列表
     deepScan(scanPath, filePath) {
         let resolvePath = hvigor_1.FileUtil.pathResolve(scanPath, filePath);
-        if (hvigor_1.FileUtil.isDictionary(resolvePath)) {
+        if (hvigor_1.FileUtil.exist(resolvePath) && hvigor_1.FileUtil.isDictionary(resolvePath)) {
             const files = fs_1.default.readdirSync(resolvePath);
-            files.forEach(file => {
+            files.forEach((file) => {
                 this.deepScan(resolvePath, file);
             });
         }
@@ -160,18 +121,17 @@ class HMRouterHvigorPlugin {
             this.scanFiles.push(resolvePath);
         }
     }
-    // 字符串转哈希码
     stringToHashCode(str) {
         let hash = 0;
-        if (str.length === 0)
+        if (str.length === 0) {
             return hash;
+        }
         for (let i = 0; i < str.length; i++) {
             const char = str.charCodeAt(i);
             hash = (hash << 5) - hash + char;
-            hash |= 0; // 转换为32位整数
+            hash |= 0;
         }
         return hash;
     }
 }
 exports.HMRouterHvigorPlugin = HMRouterHvigorPlugin;
-//# sourceMappingURL=HMRouterHvigorPlugin.js.map

package/dist/HMRouterPluginConfig.d.ts

@@ -0,0 +1,28 @@
+export declare class HMRouterPluginConfig {
+    moduleName: string;
+    modulePath: string;
+    scanDir: string[];
+    routerMapDir: string;
+    builderDir: string;
+    annotation: string[];
+    builderTpl: string;
+    saveGeneratedFile: boolean;
+    constructor(moduleName: string, modulePath: string, param: HMRouterPluginConfigParam);
+    getScanPath(dir: string): string;
+    getRelativeSourcePath(filePath: string): string;
+    getRelativeBuilderPath(filePath: string): string;
+    getGeneratedFilePath(generatorViewName: string): string;
+    getBuilderDir(): string;
+    getBuilderFilePath(generatorViewName: string): string;
+    getRouterMapDir(): string;
+    getModuleRouterMapFilePath(routerMapFileName: string): string;
+    getRawFilePath(): string;
+    getTplFilePath(): string;
+}
+export interface HMRouterPluginConfigParam {
+    scanDir?: string[];
+    routerMapDir?: string;
+    builderDir?: string;
+    saveGeneratedFile?: boolean;
+    builderTpl?: string;
+}

package/dist/HMRouterPluginConfig.js

@@ -0,0 +1,52 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HMRouterPluginConfig = void 0;
+const path_1 = __importDefault(require("path"));
+const hvigor_1 = require("@ohos/hvigor");
+const Constant_1 = require("./common/Constant");
+class HMRouterPluginConfig {
+    constructor(moduleName, modulePath, param) {
+        this.moduleName = moduleName;
+        this.modulePath = modulePath;
+        this.scanDir = param.scanDir ? [...new Set(param.scanDir)] : ['src/main/ets'];
+        this.routerMapDir = param.routerMapDir ? param.routerMapDir : 'src/main/resources/base/profile';
+        this.builderDir = param.builderDir ? param.builderDir : 'src/main/ets/generated';
+        this.annotation = ['HMRouter', 'HMAnimator', 'HMInterceptor', 'HMLifecycle', 'HMService'];
+        this.builderTpl = param.builderTpl ? param.builderTpl : 'viewBuilder.tpl';
+        this.saveGeneratedFile = !!param.saveGeneratedFile;
+    }
+    getScanPath(dir) {
+        return hvigor_1.FileUtil.pathResolve(this.modulePath, dir);
+    }
+    getRelativeSourcePath(filePath) {
+        return path_1.default.relative(this.modulePath, filePath);
+    }
+    getRelativeBuilderPath(filePath) {
+        return path_1.default.relative(this.builderDir, filePath);
+    }
+    getGeneratedFilePath(generatorViewName) {
+        return hvigor_1.FileUtil.pathResolve(this.modulePath, this.builderDir, generatorViewName + Constant_1.HMRouterPluginConstant.VIEW_NAME_SUFFIX);
+    }
+    getBuilderDir() {
+        return hvigor_1.FileUtil.pathResolve(this.modulePath, this.builderDir);
+    }
+    getBuilderFilePath(generatorViewName) {
+        return path_1.default.join(this.builderDir, generatorViewName + Constant_1.HMRouterPluginConstant.VIEW_NAME_SUFFIX);
+    }
+    getRouterMapDir() {
+        return hvigor_1.FileUtil.pathResolve(this.modulePath, this.routerMapDir, Constant_1.HMRouterPluginConstant.ROUTER_MAP_NAME);
+    }
+    getModuleRouterMapFilePath(routerMapFileName) {
+        return hvigor_1.FileUtil.pathResolve(this.modulePath, this.routerMapDir, routerMapFileName + Constant_1.HMRouterPluginConstant.JSON_SUFFIX);
+    }
+    getRawFilePath() {
+        return hvigor_1.FileUtil.pathResolve(this.modulePath, Constant_1.HMRouterPluginConstant.RAWFILE_DIR);
+    }
+    getTplFilePath() {
+        return hvigor_1.FileUtil.pathResolve(__dirname, Constant_1.HMRouterPluginConstant.PARENT_DELIMITER + this.builderTpl);
+    }
+}
+exports.HMRouterPluginConfig = HMRouterPluginConfig;

package/dist/HMRouterPluginHandle.d.ts

@@ -0,0 +1,17 @@
+import { HvigorNode } from '@ohos/hvigor';
+import { OhosHapContext, OhosHarContext, OhosHspContext } from '@ohos/hvigor-ohos-plugin';
+import { HMRouterPluginConfig } from './HMRouterPluginConfig';
+export declare class HMRouterPluginHandle {
+    private readonly node;
+    private readonly moduleContext;
+    readonly config: HMRouterPluginConfig;
+    private readonly plugin;
+    constructor(node: HvigorNode, moduleContext: OhosHapContext | OhosHarContext | OhosHspContext);
+    start(): void;
+    private copyRouterMapToRawFileTask;
+    private taskExec;
+    private updateModuleJsonOpt;
+    private updateBuildProfileOpt;
+    private pushRouterInfo;
+    private readConfig;
+}

package/{lib → dist}/HMRouterPluginHandle.js

@@ -1,18 +1,4 @@
 "use strict";
-/*
- * Copyright (c) 2024 Huawei Device Co., Ltd.
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.HMRouterPluginHandle = void 0;
 const hvigor_1 = require("@ohos/hvigor");
@@ -20,16 +6,13 @@ const HMRouterPluginConfig_1 = require("./HMRouterPluginConfig");
 const HMRouterHvigorPlugin_1 = require("./HMRouterHvigorPlugin");
 const Logger_1 = require("./common/Logger");
 const Constant_1 = require("./common/Constant");
-// HMRouterPluginHandle类，用于处理HMRouter插件
 class HMRouterPluginHandle {
-    // 构造函数，初始化节点、模块上下文、配置和插件
     constructor(node, moduleContext) {
         this.node = node;
         this.moduleContext = moduleContext;
         this.config = this.readConfig();
         this.plugin = new HMRouterHvigorPlugin_1.HMRouterHvigorPlugin(this.config);
     }
-    // 启动插件
     start() {
         Logger_1.Logger.info(`Exec ${this.moduleContext.getModuleType()}Plugin..., node:${this.node.getNodeName()}, nodePath:${this.node.getNodePath()}`);
         this.moduleContext.targets((target) => {
@@ -40,7 +23,7 @@ class HMRouterPluginHandle {
                     this.taskExec();
                 },
                 dependencies: [`${targetName}@PreBuild`],
-                postDependencies: [`${targetName}@MergeProfile`]
+                postDependencies: [`${targetName}@MergeProfile`],
             });
             this.node.registerTask({
                 name: `${targetName}@CopyRouterMapToRawFileTask`,
@@ -48,57 +31,40 @@ class HMRouterPluginHandle {
                     this.copyRouterMapToRawFileTask(target.getBuildTargetOutputPath(), targetName);
                 },
                 dependencies: [`${targetName}@ProcessRouterMap`],
-                postDependencies: [`${targetName}@ProcessResource`]
+                postDependencies: [`${targetName}@ProcessResource`],
             });
         });
     }
-    // 拷贝routerMap到raw文件
     copyRouterMapToRawFileTask(buildOutputPath, targetName) {
         let routerMapFilePath = hvigor_1.FileUtil.pathResolve(buildOutputPath, Constant_1.HMRouterPluginConstant.TEMP_ROUTER_MAP_PATH, targetName, Constant_1.HMRouterPluginConstant.ROUTER_MAP_NAME);
-        let rawFilePath = hvigor_1.FileUtil.pathResolve(this.config.modulePath, Constant_1.HMRouterPluginConstant.RAWFILE_DIR);
+        let rawFilePath = this.config.getRawFilePath();
         hvigor_1.FileUtil.ensureFileSync(rawFilePath);
         hvigor_1.FileUtil.copyFileSync(routerMapFilePath, rawFilePath);
     }
-    // 执行任务
     taskExec() {
         let startTime = Date.now();
         Logger_1.Logger.info(this.node.getNodeName() + ': HMRouterPluginTask start');
-        // 分析注解
         this.plugin.analyzeAnnotation();
-        // 更新module.json
         this.updateModuleJsonOpt();
-        // 更新profile
         this.updateBuildProfileOpt();
         let endTime = Date.now();
         Logger_1.Logger.info(this.config.moduleName + ': HMRouterPluginTask end');
         Logger_1.Logger.info(this.config.moduleName + ': HMRouterPluginTask cost: ' + (endTime - startTime) + ' ms');
     }
-    // 更新module.json
     updateModuleJsonOpt() {
-        // 获取模块的json配置
         const moduleJsonOpt = this.moduleContext.getModuleJsonOpt();
-        // 如果模块的json配置中有routerMap
         if (moduleJsonOpt.module.routerMap) {
-            // 获取routerMap的文件名
             let routerMapFileName = moduleJsonOpt.module.routerMap.split(':')[1];
-            // 获取routerMap的文件路径
-            let routerMapFilePath = hvigor_1.FileUtil.pathResolve(this.config.modulePath, this.config.routerMapDir, routerMapFileName + Constant_1.HMRouterPluginConstant.JSON_SUFFIX);
-            // 读取routerMap的json文件
+            let routerMapFilePath = this.config.getModuleRouterMapFilePath(routerMapFileName);
             let routerMapObj = hvigor_1.FileUtil.readJson5(routerMapFilePath);
-            // 将routerMap添加到plugin的routerMap中
             this.plugin.routerMap.unshift(...routerMapObj['routerMap']);
         }
-        // 生成routerMap
         this.plugin.generateRouterMap();
-        // 将routerMap的名称设置为MODULE_ROUTER_MAP_NAME
         moduleJsonOpt.module.routerMap = Constant_1.HMRouterPluginConstant.MODULE_ROUTER_MAP_NAME;
-        // 将修改后的moduleJsonOpt设置到moduleContext中
         this.moduleContext.setModuleJsonOpt(moduleJsonOpt);
     }
     updateBuildProfileOpt() {
-        // 获取构建配置选项
         const buildProfileOpt = this.moduleContext.getBuildProfileOpt();
-        // 初始化 arkOptions 和 runtimeOnly 配置
         if (!buildProfileOpt.buildOption) {
             buildProfileOpt.buildOption = {};
         }
@@ -111,12 +77,9 @@ class HMRouterPluginHandle {
         if (!buildProfileOpt.buildOption.arkOptions.runtimeOnly.sources) {
             buildProfileOpt.buildOption.arkOptions.runtimeOnly.sources = [];
         }
-        // 将路由信息推送到构建配置选项中
         this.pushRouterInfo(buildProfileOpt, this.plugin.routerMap);
-        // 将构建配置选项设置到moduleContext中
         this.moduleContext.setBuildProfileOpt(buildProfileOpt);
     }
-    // 将路由信息添加到 buildProfileOpt 中
     pushRouterInfo(buildProfileOpt, routerMap) {
         const sources = buildProfileOpt.buildOption.arkOptions.runtimeOnly.sources;
         routerMap.forEach((item) => {
@@ -129,7 +92,6 @@ class HMRouterPluginHandle {
             }
         });
     }
-    // 读取配置
     readConfig() {
         let levels = 0;
         let configParam = {};
@@ -145,4 +107,3 @@ class HMRouterPluginHandle {
     }
 }
 exports.HMRouterPluginHandle = HMRouterPluginHandle;
-//# sourceMappingURL=HMRouterPluginHandle.js.map