@hadss/hmrouter-plugin 1.0.0-rc.1 → 1.0.0-rc.11

package/src/HMRouterPluginHandle.ts

@@ -1,188 +0,0 @@
-/*
- *   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.
- */
-
-import { FileUtil, HvigorNode } from '@ohos/hvigor'
-import { OhosHapContext, OhosHarContext, OhosHspContext, Target } from '@ohos/hvigor-ohos-plugin'
-import { HMRouterPluginConfig } from './HMRouterPluginConfig'
-import { HMRouterHvigorPlugin } from './HMRouterHvigorPlugin'
-import { Logger } from './common/Logger'
-import { HMRouterPluginConstant } from './common/Constant'
-import { RouterInfo } from './common/PluginModel'
-
-// HMRouterPluginHandle类，用于处理HMRouter插件
-export class HMRouterPluginHandle {
-  // 节点
-  private readonly node: HvigorNode
-  // 模块上下文
-  private readonly moduleContext: OhosHapContext | OhosHarContext | OhosHspContext
-  // 配置
-  public readonly config: HMRouterPluginConfig
-  // 插件
-  private readonly plugin: HMRouterHvigorPlugin
-
-  // 构造函数，初始化节点、模块上下文、配置和插件
-  constructor(node: HvigorNode, moduleContext: OhosHapContext | OhosHarContext | OhosHspContext) {
-    this.node = node
-    this.moduleContext = moduleContext
-    this.config = this.readConfig()
-    this.plugin = new HMRouterHvigorPlugin(this.config)
-  }
-
-  // 启动插件
-  public start() {
-    Logger.i(`Exec ${this.moduleContext.getModuleType()}Plugin..., node:${this.node.getNodeName()}, nodePath:${this.node.getNodePath()}`)
-    this.moduleContext.targets((target: Target) => {
-      const targetName = target.getTargetName()
-      this.node.registerTask({
-        name: `${targetName}@HMRouterPluginTask`,
-        run: () => {
-          this.taskExec()
-        },
-        dependencies: [`${targetName}@PreBuild`],
-        postDependencies: [`${targetName}@MergeProfile`]
-      })
-
-      this.node.registerTask({
-        name: `${targetName}@CopyRouterMapToRawFileTask`,
-        run: () => {
-          this.copyRouterMapToRawFileTask(target.getBuildTargetOutputPath(), targetName)
-        },
-        dependencies: [`${targetName}@ProcessRouterMap`],
-        postDependencies: [`${targetName}@ProcessResource`]
-      })
-    })
-  }
-
-  // 拷贝routerMap到raw文件
-  private copyRouterMapToRawFileTask(buildOutputPath: string, targetName: string) {
-    let routerMapFilePath = FileUtil.pathResolve(
-      buildOutputPath,
-      HMRouterPluginConstant.TEMP_ROUTER_MAP_PATH,
-      targetName,
-      HMRouterPluginConstant.ROUTER_MAP_NAME
-    )
-    let rawFilePath = FileUtil.pathResolve(this.config.modulePath, HMRouterPluginConstant.RAWFILE_DIR)
-    FileUtil.ensureFileSync(rawFilePath)
-    FileUtil.copyFileSync(routerMapFilePath, rawFilePath)
-  }
-
-  // 执行任务
-  private taskExec() {
-    let startTime = Date.now()
-    Logger.i(this.node.getNodeName() + ' :HMRouterPluginTask start---' + startTime)
-
-    // 分析注解
-    this.plugin.analyzeAnnotation()
-    // 更新module.json
-    this.updateModuleJsonOpt()
-    // 更新profile
-    this.updateBuildProfileOpt()
-
-    let endTime = Date.now()
-    Logger.i(this.config.moduleName + ' :HMRouterPluginTask end---' + endTime)
-    Logger.i(this.config.moduleName + ' :HMRouterPluginTask cost---' + (endTime - startTime) + 'ms')
-  }
-
-  // 更新module.json
-  private updateModuleJsonOpt() {
-    // 获取模块的json配置
-    const moduleJsonOpt = this.moduleContext.getModuleJsonOpt()
-    // 如果模块的json配置中有routerMap
-    if (moduleJsonOpt.module.routerMap) {
-      // 获取routerMap的文件名
-      let routerMapFileName = moduleJsonOpt.module.routerMap.split(':')[1]
-      // 获取routerMap的文件路径
-      let routerMapFilePath = FileUtil.pathResolve(
-        this.config.modulePath,
-        this.config.routerMapDir,
-        routerMapFileName + HMRouterPluginConstant.JSON_SUFFIX
-      )
-      // 读取routerMap的json文件
-      let routerMapObj = FileUtil.readJson5(routerMapFilePath)
-      // 将routerMap添加到plugin的routerMap中
-      this.plugin.routerMap.unshift(...((routerMapObj as any)['routerMap'] as Array<RouterInfo>))
-    }
-    // 生成routerMap
-    this.plugin.generateRouterMap()
-    // 将routerMap的名称设置为MODULE_ROUTER_MAP_NAME
-    moduleJsonOpt.module.routerMap = HMRouterPluginConstant.MODULE_ROUTER_MAP_NAME
-    // 将修改后的moduleJsonOpt设置到moduleContext中
-    this.moduleContext.setModuleJsonOpt(moduleJsonOpt)
-  }
-
-  private updateBuildProfileOpt() {
-    // 获取构建配置选项
-    const buildProfileOpt = this.moduleContext.getBuildProfileOpt()
-
-    // 初始化 arkOptions 和 runtimeOnly 配置
-    if (!buildProfileOpt.buildOption) {
-      buildProfileOpt.buildOption = {}
-    }
-
-    if (!buildProfileOpt.buildOption.arkOptions) {
-      buildProfileOpt.buildOption.arkOptions = {}
-    }
-
-    if (!buildProfileOpt.buildOption.arkOptions.runtimeOnly) {
-      buildProfileOpt.buildOption.arkOptions.runtimeOnly = {}
-    }
-
-    if (!buildProfileOpt.buildOption.arkOptions.runtimeOnly.sources) {
-      buildProfileOpt.buildOption.arkOptions.runtimeOnly.sources = []
-    }
-
-    // 将路由信息推送到构建配置选项中
-    this.pushRouterInfo(buildProfileOpt, this.plugin.routerMap)
-
-    // 将构建配置选项设置到moduleContext中
-    this.moduleContext.setBuildProfileOpt(buildProfileOpt)
-  }
-
-  // 将路由信息添加到 buildProfileOpt 中
-  private pushRouterInfo(buildProfileOpt: any, routerMap: Array<RouterInfo>) {
-    const sources = buildProfileOpt.buildOption.arkOptions.runtimeOnly.sources
-
-    routerMap.forEach((item: RouterInfo) => {
-      const name = item.name
-      if (
-        name.includes(HMRouterPluginConstant.LIFECYCLE_PREFIX) ||
-        name.includes(HMRouterPluginConstant.INTERCEPTOR_PREFIX) ||
-        name.includes(HMRouterPluginConstant.ANIMATOR_PREFIX) ||
-        name.includes(HMRouterPluginConstant.SERVICE_PREFIX)
-      ) {
-        sources.push('./' + item.pageSourceFile)
-      }
-    })
-  }
-
-  // 读取配置
-  private readConfig(): HMRouterPluginConfig {
-    let levels = 0
-    let configParam = {}
-    while (levels < 4) {
-      let configFilePath = FileUtil.pathResolve(
-        this.node.getNodePath(),
-        HMRouterPluginConstant.PARENT_DELIMITER.repeat(levels) + HMRouterPluginConstant.CONFIG_FILE_NAME
-      )
-      if (FileUtil.exist(configFilePath)) {
-        configParam = FileUtil.readJson5(configFilePath)
-        break
-      }
-      levels++
-    }
-
-    return new HMRouterPluginConfig(this.node.getNodeName(), this.node.getNodePath(), configParam)
-  }
-}

package/src/Index.ts

@@ -1,151 +0,0 @@
-/*
- *   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.
- */
-
-import {FileUtil, hvigor, HvigorNode, HvigorPlugin} from '@ohos/hvigor'
-import {OhosHapContext, OhosHarContext, OhosHspContext, OhosPluginId} from '@ohos/hvigor-ohos-plugin'
-import {HMRouterPluginHandle} from './HMRouterPluginHandle'
-import {HMRouterPluginConstant} from './common/Constant'
-import {Logger, PluginError} from './common/Logger'
-import fs from 'fs'
-
-// HMRouterPluginMgr类，用于管理HMRouterPluginHandle实例
-class HMRouterPluginMgr {
-  // HMRouterPluginHandle实例集合
-  hmRouterPluginSet: Set<HMRouterPluginHandle> = new Set()
-
-  // 构造函数，在hvigor节点评估后启动所有HMRouterPluginHandle实例，在hvigor构建完成后删除生成的文件
-  constructor() {
-    hvigor.nodesEvaluated(() => {
-      this.hmRouterPluginSet.forEach(pluginHandle => {
-        pluginHandle.start()
-      })
-    })
-
-    hvigor.buildFinished(() => {
-      this.deleteGeneratorFile()
-      HMRouterPluginMgrInstance = null
-    })
-  }
-
-  // 注册HMRouterPluginHandle实例
-  public registerHMRouterPlugin(node: HvigorNode, pluginId: string) {
-    // 获取节点上下文
-    const moduleContext = node.getContext(pluginId) as OhosHapContext | OhosHarContext | OhosHspContext
-
-    // 如果节点上下文为空，抛出错误
-    if (!moduleContext) {
-      Logger.e(PluginError.ERR_ERROR_CONFIG, node.getNodePath())
-      throw new Error('moduleContext is null')
-    }
-
-    // 创建HMRouterPluginHandle实例
-    let pluginHandle = new HMRouterPluginHandle(node, moduleContext)
-    // 如果插件ID为OHOS_HAP_PLUGIN，设置模块名称
-    if (pluginId === OhosPluginId.OHOS_HAP_PLUGIN) {
-      let packageJson: any = FileUtil.readJson5(FileUtil.pathResolve(node.getNodePath(), 'oh-package.json5'))
-      pluginHandle.config.moduleName = packageJson.name
-    }
-
-    // 将HMRouterPluginHandle实例添加到集合中
-    this.hmRouterPluginSet.add(pluginHandle)
-  }
-
-  // 删除生成的文件
-  private deleteGeneratorFile() {
-    Logger.i('deleteGeneratorFile exec...')
-    for (let hmRouterPlugin of this.hmRouterPluginSet) {
-      // 如果saveGeneratedFile为true，跳过删除
-      if (hmRouterPlugin.config.saveGeneratedFile) {
-        Logger.i(hmRouterPlugin.config.moduleName + ' saveGeneratedFile is true, skip delete')
-        continue
-      }
-      // 获取routerMapDirPath路径
-      let routerMapDirPath = FileUtil.pathResolve(
-        hmRouterPlugin.config.modulePath,
-        hmRouterPlugin.config.routerMapDir,
-        HMRouterPluginConstant.ROUTER_MAP_NAME
-      )
-      // 如果路径存在，删除hm_router_map.json文件
-      if (FileUtil.exist(routerMapDirPath)) {
-        fs.unlinkSync(routerMapDirPath)
-        Logger.i(routerMapDirPath + ' delete hm_router_map.json')
-      }
-      // 获取builderDirPath路径
-      let builderDirPath = FileUtil.pathResolve(hmRouterPlugin.config.modulePath, hmRouterPlugin.config.builderDir)
-      // 如果路径存在，删除builder目录
-      if (FileUtil.exist(builderDirPath)) {
-        fs.rmSync(builderDirPath, {
-          recursive: true
-        })
-        Logger.i(hmRouterPlugin.config.modulePath + ' delete builder dir')
-      }
-      // 获取rawFile路径
-      let rawFilePath = FileUtil.pathResolve(hmRouterPlugin.config.modulePath, HMRouterPluginConstant.RAWFILE_DIR)
-      // 如果路径存在，删除builder目录
-      if (FileUtil.exist(rawFilePath)) {
-        fs.unlinkSync(rawFilePath)
-        Logger.i(hmRouterPlugin.config.modulePath + ' delete rawfile hm_router_map.json')
-      } 
-    }
-  }
-}
-
-// HMRouterPluginMgr实例
-let HMRouterPluginMgrInstance: HMRouterPluginMgr | null = null
-
-// hap插件
-export function hapPlugin(): HvigorPlugin {
-  return {
-    pluginId: HMRouterPluginConstant.HAP_PLUGIN_ID,
-    apply(node: HvigorNode) {
-      // 如果HMRouterPluginMgr实例为空，创建新的实例
-      if (!HMRouterPluginMgrInstance) {
-        HMRouterPluginMgrInstance = new HMRouterPluginMgr()
-      }
-      // 注册HMRouterPluginHandle实例
-      HMRouterPluginMgrInstance.registerHMRouterPlugin(node, OhosPluginId.OHOS_HAP_PLUGIN)
-    }
-  }
-}
-
-// hsp插件
-export function hspPlugin(): HvigorPlugin {
-  return {
-    pluginId: HMRouterPluginConstant.HSP_PLUGIN_ID,
-    apply(node: HvigorNode) {
-      // 如果HMRouterPluginMgr实例为空，创建新的实例
-      if (!HMRouterPluginMgrInstance) {
-        HMRouterPluginMgrInstance = new HMRouterPluginMgr()
-      }
-      // 注册HMRouterPluginHandle实例
-      HMRouterPluginMgrInstance.registerHMRouterPlugin(node, OhosPluginId.OHOS_HSP_PLUGIN)
-    }
-  }
-}
-
-// har插件
-export function harPlugin(): HvigorPlugin {
-  return {
-    pluginId: HMRouterPluginConstant.HAR_PLUGIN_ID,
-    apply(node: HvigorNode) {
-      // 如果HMRouterPluginMgr实例为空，创建新的实例
-      if (!HMRouterPluginMgrInstance) {
-        HMRouterPluginMgrInstance = new HMRouterPluginMgr()
-      }
-      // 注册HMRouterPluginHandle实例
-      HMRouterPluginMgrInstance.registerHMRouterPlugin(node, OhosPluginId.OHOS_HAR_PLUGIN)
-    }
-  }
-}

package/src/common/Constant.ts

@@ -1,49 +0,0 @@
-/*
- *   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.
- */
-
-import path from 'path'
-
-export class HMRouterPluginConstant {
-  static readonly ANIMATOR_PREFIX = '__animator__'
-  static readonly INTERCEPTOR_PREFIX = '__interceptor__'
-  static readonly LIFECYCLE_PREFIX = '__lifecycle__'
-  static readonly SERVICE_PREFIX = '__service__'
-  static readonly PAGE_URL_PREFIX = ''
-
-  static readonly FILE_SEPARATOR = path.sep
-  static readonly DELIMITER = '/'
-
-  static readonly MODULE_ROUTER_MAP_NAME = '$profile:hm_router_map'
-  static readonly ROUTER_MAP_NAME = 'hm_router_map.json'
-  static readonly TEMP_ROUTER_MAP_PATH = '../../intermediates/router_map'
-  static readonly RAWFILE_DIR = 'src/main/resources/rawfile/hm_router_map.json'
-  static readonly VIEW_NAME_PREFIX = 'HM'
-  static readonly VIEW_NAME_SUFFIX = '.ets'
-  static readonly JSON_SUFFIX = '.json'
-
-  static readonly HAP_PLUGIN_ID = 'HAP_HMROUTER_PLUGIN'
-  static readonly HSP_PLUGIN_ID = 'HSP_HMROUTER_PLUGIN'
-  static readonly HAR_PLUGIN_ID = 'HAR_HMROUTER_PLUGIN'
-
-  static readonly ROUTER_ANNOTATION = 'HMRouter'
-  static readonly ANIMATOR_ANNOTATION = 'HMAnimator'
-  static readonly INTERCEPTOR_ANNOTATION = 'HMInterceptor'
-  static readonly LIFECYCLE_ANNOTATION = 'HMLifecycle'
-  static readonly SERVICE_ANNOTATION = 'HMService'
-  static readonly CLASS_ANNOTATION_ARR = ['HMAnimator', 'HMInterceptor', 'HMLifecycle']
-
-  static readonly CONFIG_FILE_NAME = 'hmrouter_config.json'
-  static readonly PARENT_DELIMITER = '../'
-}

package/src/common/Logger.ts

@@ -1,73 +0,0 @@
-/*
- *   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.
- */
-
-import {HvigorLogger} from "@ohos/hvigor";
-
-export class Logger {
-  static e(format: string, ...args: string[]) {
-    let formatStr: string = format
-    if (DEFINED_ERROR.has(format)) {
-      formatStr = `errorCode ${DEFINED_ERROR.get(format)?.errorCode}, errorMsg: ${DEFINED_ERROR.get(format)?.errorMsg}`
-    }
-
-    const publicFormat =
-      `[HMRouterPlugin ERROR]${formatStr.replace('%s', args[0])}`
-    HvigorLogger.getLogger().error(publicFormat)
-  }
-
-  static i(msg: string, ...args: unknown[]) {
-    HvigorLogger.getLogger().info(msg, ...args)
-  }
-}
-
-export enum PluginError {
-  ERR_DUPLICATE_NAME = 'ERR_DUPLICATE_NAME',
-  ERR_WRONG_DECORATION = 'ERR_DUPLICATE_',
-  ERR_REPEAT_ANNOTATION = 'ERR_INIT_FRAMEWORK',
-  ERR_ERROR_CONFIG = 'ERR_INIT_COMPONENT',
-  ERR_NOT_EMPTY_STRING = 'ERR_INIT_NOT_READY'
-}
-
-interface PluginErrorInfo {
-  errorCode: number
-  errorMsg: string
-}
-
-const DEFINED_ERROR: Map<string, PluginErrorInfo> = new Map()
-
-DEFINED_ERROR.set(PluginError.ERR_DUPLICATE_NAME, {
-  errorCode: 40000001,
-  errorMsg: '重复的pageUrl、拦截器、生命周期、动画、服务 - %s',
-})
-
-DEFINED_ERROR.set(PluginError.ERR_WRONG_DECORATION, {
-  errorCode: 40000002,
-  errorMsg: '@HMRouter修饰的组件不能包含NavDestination - %s',
-})
-
-DEFINED_ERROR.set(PluginError.ERR_REPEAT_ANNOTATION, {
-  errorCode: 40000003,
-  errorMsg: '文件 %s 中存在多个HMRouter注解',
-})
-
-DEFINED_ERROR.set(PluginError.ERR_ERROR_CONFIG, {
-  errorCode: 40000004,
-  errorMsg: 'moduleContext is null 请检查插件的hvigorfile配置 - %s',
-})
-
-DEFINED_ERROR.set(PluginError.ERR_NOT_EMPTY_STRING, {
-  errorCode: 40000005,
-  errorMsg: '%s 常量值不能为空字符串 - %s',
-})

package/src/common/PluginModel.ts

@@ -1,83 +0,0 @@
-/*
- *   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.
- */
-
-export type AnalyzerResultLike = HMRouterResult | HMAnimatorResult | HMInterceptorResult | HMLifecycleResult | HMServiceResult
-
-export interface BaseAnalyzeResult {
-  name?: string // 类名
-  module?: string // 模块名
-  annotation?: string // 注解
-}
-
-export interface HMRouterResult extends BaseAnalyzeResult {
-  pageUrl?: any // 跳转路径
-  dialog?: boolean // 是否弹窗
-  singleton?: boolean // 是否单例
-  interceptors?: string[] // 拦截器
-  animator?: string // 动画
-  lifecycle?: string // 生命周期
-}
-
-export interface HMAnimatorResult extends BaseAnalyzeResult {
-  animatorName?: string // 动画名称
-}
-
-export interface HMInterceptorResult extends BaseAnalyzeResult {
-  interceptorName?: string // 拦截器名称
-  priority?: number // 优先级
-  global?: boolean // 是否全局
-}
-
-export interface HMLifecycleResult extends BaseAnalyzeResult {
-  lifecycleName?: string // 生命周期名称
-  priority?: number // 优先级
-  global?: boolean // 是否全局
-}
-
-export interface HMServiceResult extends BaseAnalyzeResult {
-  serviceName?: string // 服务名称
-  functionName?: string // 函数名称
-  singleton?: boolean // 是否单例
-}
-
-export class TemplateModel {
-  pageUrl: string
-  importPath: string
-  componentName: string
-  dialog: boolean
-  generatorViewName: string
-
-  constructor(pageUrl: string, importPath: string, componentName: string, dialog: boolean, generatorViewName: string) {
-    this.pageUrl = pageUrl
-    this.importPath = importPath
-    this.componentName = componentName
-    this.dialog = dialog
-    this.generatorViewName = generatorViewName
-  }
-}
-
-export class RouterInfo {
-  name: string
-  pageSourceFile: string
-  buildFunction: string
-  customData: AnalyzerResultLike
-
-  constructor(name: string, pageSourceFile: string, buildFunction: string, data: AnalyzerResultLike = {}) {
-    this.name = name
-    this.pageSourceFile = pageSourceFile
-    this.buildFunction = buildFunction
-    this.customData = data
-  }
-}

package/tsconfig.json

@@ -1,14 +0,0 @@
-{
-  "compilerOptions": {
-    "target": "ES2021",
-    "module": "commonjs",
-    "strict": true,
-    "esModuleInterop": true,
-    "skipLibCheck": true,
-    "forceConsistentCasingInFileNames": true,
-    "sourceMap": true,
-    "outDir": "./lib"
-  },
-  "include": [".eslintrc.js","src/**/*"],
-  "exclude": ["node_modules", "lib/**/*"]
-}