@hadss/hmrouter-plugin 1.2.2 → 1.2.3-rc.0

package/README.md

@@ -16,12 +16,14 @@ HMRouter编译插件是一个基于hvigor的编译插件，用于：
 
 ### 工程级配置
 
+***插件版本建议和库的版本保持一致***
+
 在工程的`hvigor/hvigor-config.json`文件中添加路由编译插件：
 
 ```json5
 {
   "dependencies": {
-    "@hadss/hmrouter-plugin": "^1.2.2"  // 使用最新版本
+    "@hadss/hmrouter-plugin": "^1.2.3-rc.0"  // 使用最新版本
   },
   // ...其余配置
 }
@@ -438,6 +440,10 @@ hvigor 5.7.3及以上
 
 ## 更新日志
 
+### 1.2.3-rc.0 (2025.12.11)
+
+- [修复库版本与插件版本不匹配时编译报错的问题](https://gitcode.com/openharmony-sig/ohrouter/issues/250)
+
 ### 1.2.2 (2025.10.24)
 
 - [修复系统路由表合并异常的问题](https://gitcode.com/openharmony-sig/ohrouter/issues/215)

package/dist/hmrouter_extension/constants/FilePathConstants.d.ts

@@ -12,6 +12,7 @@ export default class FilePathConstants {
     static readonly CURRENT_DELIMITER = "./";
     static readonly OH_MODULE_PATH = "oh_modules";
     static readonly OH_PACKAGE_FILE_NAME = "oh-package.json5";
+    static readonly OH_PACKAGE_LOCK_FILE_NAME = "oh-package-lock.json5";
     static readonly LINE_BREAK = "\n";
     static readonly BUILD_PROFILE = "build-profile.json5";
     static readonly SDK_HOME = "default/openharmony/ets/oh-uni-package.json";

package/dist/hmrouter_extension/constants/FilePathConstants.js

@@ -20,6 +20,7 @@ FilePathConstants.PARENT_DELIMITER = '../';
 FilePathConstants.CURRENT_DELIMITER = './';
 FilePathConstants.OH_MODULE_PATH = 'oh_modules';
 FilePathConstants.OH_PACKAGE_FILE_NAME = 'oh-package.json5';
+FilePathConstants.OH_PACKAGE_LOCK_FILE_NAME = 'oh-package-lock.json5';
 FilePathConstants.LINE_BREAK = '\n';
 FilePathConstants.BUILD_PROFILE = 'build-profile.json5';
 FilePathConstants.SDK_HOME = 'default/openharmony/ets/oh-uni-package.json';

package/dist/hmrouter_extension/constants/TemplateConstants.d.ts

@@ -2,5 +2,6 @@ export default class TemplateConstants {
     static readonly CUSTOM_BUILDER_TEMPLATE = "template/customBuilder.ejs";
     static readonly VIEW_BUILDER_TEMPLATE = "template/viewBuilder.ejs";
     static readonly V1_TEMPLATE = "template/viewBuilder_v1.ejs";
+    static readonly V1_1_TEMPLATE = "template/viewBuilder_v1_1.ejs";
     static readonly WARP_BUILDER = "WrapBuilder";
 }

package/dist/hmrouter_extension/constants/TemplateConstants.js

@@ -6,4 +6,5 @@ exports.default = TemplateConstants;
 TemplateConstants.CUSTOM_BUILDER_TEMPLATE = 'template/customBuilder.ejs';
 TemplateConstants.VIEW_BUILDER_TEMPLATE = 'template/viewBuilder.ejs';
 TemplateConstants.V1_TEMPLATE = 'template/viewBuilder_v1.ejs';
+TemplateConstants.V1_1_TEMPLATE = 'template/viewBuilder_v1_1.ejs';
 TemplateConstants.WARP_BUILDER = 'WrapBuilder';

package/dist/hmrouter_extension/constants/VersionConstants.d.ts

@@ -3,4 +3,6 @@ export default class VersionConstants {
     static readonly HMROUTER_LIB_NAME = "hmrouter";
     static readonly HMROUTER_VERSION_KEY = "version";
     static readonly HMROUTER_VERSION_V1 = "1.0.0";
+    static readonly HMROUTER_MIN_VERSION_FOR_NAV_HELPER = "1.1.0";
+    static readonly HMROUTER_MIN_VERSION_FOR_SDK_API = "1.2.0";
 }

package/dist/hmrouter_extension/constants/VersionConstants.js

@@ -7,3 +7,5 @@ VersionConstants.HMROUTER_ORGANIZATION = '@hadss';
 VersionConstants.HMROUTER_LIB_NAME = 'hmrouter';
 VersionConstants.HMROUTER_VERSION_KEY = 'version';
 VersionConstants.HMROUTER_VERSION_V1 = '1.0.0';
+VersionConstants.HMROUTER_MIN_VERSION_FOR_NAV_HELPER = '1.1.0';
+VersionConstants.HMROUTER_MIN_VERSION_FOR_SDK_API = '1.2.0';

package/dist/hmrouter_extension/processor/CodeGenerationProcessor.d.ts

@@ -11,8 +11,12 @@ export declare class CodeGenerationProcessor {
     private matchedPath;
     private prepareTemplateModel;
     private determineTemplatePath;
+    private determineTemplateType;
     private generateFile;
     private detectLibraryVersion;
     private detectLibraryVersion2;
+    private extractHMRouterVersion;
     private getLibraryPossiblePaths;
+    private parseVersion;
+    private compareVersions;
 }

package/dist/hmrouter_extension/processor/CodeGenerationProcessor.js

@@ -125,14 +125,43 @@ class CodeGenerationProcessor {
     determineTemplatePath(analyzeResult, defaultTemplatePath) {
         const libraryVersion = this.detectLibraryVersion();
         framework_1.Logger.debug(this.context.node.getNodeName(), `Library version: ${libraryVersion}`);
-        const useV1Template = libraryVersion.startsWith(constants_1.VersionConstants.HMROUTER_VERSION_V1);
-        if (useV1Template) {
-            return framework_1.PluginFileUtil.pathResolve(__dirname, constants_1.FilePathConstants.PARENT_DELIMITER.repeat(3) + constants_1.TemplateConstants.V1_TEMPLATE);
-        }
-        else if (analyzeResult.useNavDst === true) {
+        if (analyzeResult.useNavDst === true) {
             return framework_1.PluginFileUtil.pathResolve(__dirname, constants_1.FilePathConstants.PARENT_DELIMITER.repeat(3), constants_1.TemplateConstants.CUSTOM_BUILDER_TEMPLATE);
         }
-        return defaultTemplatePath;
+        const templateType = this.determineTemplateType(libraryVersion);
+        if (templateType !== 'latest' && libraryVersion) {
+            framework_1.Logger.warn(this.context.node.getNodeName(), `[HMRouter Version Compatibility] Detected library version ${libraryVersion}, ` +
+                `which is below the minimum recommended version ${constants_1.VersionConstants.HMROUTER_MIN_VERSION_FOR_SDK_API}. ` +
+                `Automatically switched to compatible template (${templateType}). ` +
+                `Please upgrade @hadss/hmrouter to ${constants_1.VersionConstants.HMROUTER_MIN_VERSION_FOR_SDK_API} or higher for full feature support.`);
+        }
+        switch (templateType) {
+            case 'v1':
+                return framework_1.PluginFileUtil.pathResolve(__dirname, constants_1.FilePathConstants.PARENT_DELIMITER.repeat(3) + constants_1.TemplateConstants.V1_TEMPLATE);
+            case 'v1_1':
+                return framework_1.PluginFileUtil.pathResolve(__dirname, constants_1.FilePathConstants.PARENT_DELIMITER.repeat(3) + constants_1.TemplateConstants.V1_1_TEMPLATE);
+            case 'latest':
+            default:
+                return defaultTemplatePath;
+        }
+    }
+    determineTemplateType(libraryVersion) {
+        if (!libraryVersion) {
+            return 'v1';
+        }
+        const currentVersion = this.parseVersion(libraryVersion);
+        const v1_1Version = this.parseVersion(constants_1.VersionConstants.HMROUTER_MIN_VERSION_FOR_NAV_HELPER);
+        const v1_2Version = this.parseVersion(constants_1.VersionConstants.HMROUTER_MIN_VERSION_FOR_SDK_API);
+        if (!currentVersion || !v1_1Version || !v1_2Version) {
+            return 'v1';
+        }
+        if (this.compareVersions(currentVersion, v1_2Version) >= 0) {
+            return 'latest';
+        }
+        if (this.compareVersions(currentVersion, v1_1Version) >= 0) {
+            return 'v1_1';
+        }
+        return 'v1';
     }
     generateFile(templateModel, templatePath) {
         if (!framework_1.PluginFileUtil.exist(templatePath)) {
@@ -158,26 +187,78 @@ class CodeGenerationProcessor {
         }
         return libraryVersion;
     }
-    detectLibraryVersion2(packagePath) {
-        let libraryVersion = '';
+    detectLibraryVersion2(lockFilePath) {
         try {
-            if (framework_1.PluginFileUtil.exist(packagePath)) {
-                const packageJson = framework_1.PluginFileUtil.readJson5(packagePath);
-                libraryVersion = packageJson[constants_1.VersionConstants.HMROUTER_VERSION_KEY] || '';
+            if (!framework_1.PluginFileUtil.exist(lockFilePath)) {
+                return '';
             }
+            const lockFileData = framework_1.PluginFileUtil.readJson5(lockFilePath);
+            return this.extractHMRouterVersion(lockFileData.packages);
         }
         catch (error) {
+            return '';
         }
-        return libraryVersion;
+    }
+    extractHMRouterVersion(packages) {
+        if (!packages) {
+            return '';
+        }
+        const hmrouterPrefix = `${constants_1.VersionConstants.HMROUTER_ORGANIZATION}/${constants_1.VersionConstants.HMROUTER_LIB_NAME}@`;
+        for (const key of Object.keys(packages)) {
+            if (!key.startsWith(hmrouterPrefix)) {
+                continue;
+            }
+            const packageInfo = packages[key];
+            if (packageInfo && packageInfo[constants_1.VersionConstants.HMROUTER_VERSION_KEY]) {
+                return packageInfo[constants_1.VersionConstants.HMROUTER_VERSION_KEY];
+            }
+        }
+        return '';
     }
     getLibraryPossiblePaths() {
         const paths = [];
-        paths.push(framework_1.PluginFileUtil.pathResolve(this.context.config.modulePath, constants_1.FilePathConstants.OH_MODULE_PATH, constants_1.VersionConstants.HMROUTER_ORGANIZATION, constants_1.VersionConstants.HMROUTER_LIB_NAME, constants_1.FilePathConstants.OH_PACKAGE_FILE_NAME));
+        paths.push(framework_1.PluginFileUtil.pathResolve(this.context.config.modulePath, constants_1.FilePathConstants.OH_PACKAGE_LOCK_FILE_NAME));
         const projectRoot = framework_1.PluginStore.getInstance().get('projectFilePath');
         if (projectRoot && projectRoot !== this.context.config.modulePath) {
-            paths.push(framework_1.PluginFileUtil.pathResolve(projectRoot, constants_1.FilePathConstants.OH_MODULE_PATH, constants_1.VersionConstants.HMROUTER_ORGANIZATION, constants_1.VersionConstants.HMROUTER_LIB_NAME, constants_1.FilePathConstants.OH_PACKAGE_FILE_NAME));
+            paths.push(framework_1.PluginFileUtil.pathResolve(projectRoot, constants_1.FilePathConstants.OH_PACKAGE_LOCK_FILE_NAME));
         }
         return paths;
     }
+    parseVersion(version) {
+        const match = version.match(/^(\d+)\.(\d+)\.(\d+)(-.*)?/);
+        if (!match) {
+            return null;
+        }
+        return {
+            major: parseInt(match[1], 10),
+            minor: parseInt(match[2], 10),
+            patch: parseInt(match[3], 10),
+            preRelease: match[4] || '',
+        };
+    }
+    compareVersions(v1, v2) {
+        if (v1.major !== v2.major) {
+            return v1.major < v2.major ? -1 : 1;
+        }
+        if (v1.minor !== v2.minor) {
+            return v1.minor < v2.minor ? -1 : 1;
+        }
+        if (v1.patch !== v2.patch) {
+            return v1.patch < v2.patch ? -1 : 1;
+        }
+        if (v1.preRelease && !v2.preRelease) {
+            return -1;
+        }
+        if (!v1.preRelease && v2.preRelease) {
+            return 1;
+        }
+        if (v1.preRelease < v2.preRelease) {
+            return -1;
+        }
+        if (v1.preRelease > v2.preRelease) {
+            return 1;
+        }
+        return 0;
+    }
 }
 exports.CodeGenerationProcessor = CodeGenerationProcessor;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hadss/hmrouter-plugin",
-  "version": "1.2.2",
+  "version": "1.2.3-rc.0",
   "description": "HMRouter Compiler Plugin",
   "main": "dist/Index.js",
   "scripts": {

package/template/viewBuilder_v1_1.ejs

@@ -0,0 +1,51 @@
+/*
+ * 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.
+ */
+
+// instrument ignore file
+// auto-generated <%= componentName %>Builder.ets by HMRouter
+import <%if(isDefaultExport) {%> <%= componentName %> <% } else {%> { <%= componentName %> } <% } %> from '<%= importPath %>'
+import { NavDestinationHelper } from '@hadss/hmrouter';
+
+@Builder
+export function <%= componentName %>Builder(name: string, param: Object) {
+  <%= componentName %>Generated()
+}
+
+export const <%= componentName %>BuilderWrapBuilder = wrapBuilder(<%= componentName %>Builder)
+
+@Component
+export struct <%= componentName %>Generated {
+  private helper: NavDestinationHelper = new NavDestinationHelper(this);
+
+  build() {
+    NavDestination() {
+      <%= componentName %>()
+    }
+    <% if(dialog){ %>.mode(NavDestinationMode.DIALOG)<% } %>
+    .hideTitleBar(true)
+    .attributeModifier(this.helper.modifier)
+    .gestureModifier(this.helper.gestureModifier)
+    .onWillAppear(()=>{this.helper.onWillAppear()})
+    .onAppear(() => {this.helper.onAppear()})
+    .onWillShow(()=>{this.helper.onWillShow()})
+    .onShown(()=>{this.helper.onShown()})
+    .onWillHide(()=>{this.helper.onWillHide()})
+    .onHidden(()=>{this.helper.onHidden()})
+    .onWillDisappear(()=>{this.helper.onWillDisappear()})
+    .onDisAppear(()=>{this.helper.onDisAppear()})
+    .onReady((ctx)=>{this.helper.onReady(ctx)})
+    .onBackPressed(()=> this.helper.onBackPressed())
+  }
+}