@hadss/hmrouter-plugin 1.0.0-rc.0 → 1.0.0-rc.10

package/src/Index.ts

@@ -1,218 +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 { hvigor, HvigorLogger, HvigorNode, HvigorPlugin, Json5Reader, levels } from '@ohos/hvigor'
-import {
-  OhosHapContext,
-  OhosHarContext,
-  OhosHspContext,
-  OhosPluginId,
-  Target
-} from '@ohos/hvigor-ohos-plugin'
-import fs from 'fs'
-import path from 'path'
-import { HMRouterPluginConfig } from './HMRouterPluginConfig'
-import { OhosModuleContext } from '@ohos/hvigor-ohos-plugin/src/plugin/context/plugin-context'
-import { HMRouterHvigorPlugin, RouterInfo } from './HMRouterHvigorPlugin'
-
-type ContextLike = OhosHapContext | OhosHarContext | OhosHspContext
-
-const HAP_PLUGIN_ID = 'HAP_HMROUTER_PLUGIN'
-const HSP_PLUGIN_ID = 'HSP_HMROUTER_PLUGIN'
-const HAR_PLUGIN_ID = 'HAR_HMROUTER_PLUGIN'
-
-const Logger = HvigorLogger.getLogger()
-
-let modulePathArr: string[] = []
-
-function readConfig(node: HvigorNode): HMRouterPluginConfig {
-  let configParam = {}
-  let configFilePath = path.resolve(node.getNodePath(), './hmrouter_config.json')
-  if (fs.existsSync(configFilePath)) {
-    configParam = JSON.parse(fs.readFileSync(configFilePath, 'utf-8'))
-  } else {
-    configFilePath = path.resolve(node.getNodePath(), '../hmrouter_config.json')
-    if (fs.existsSync(configFilePath)) {
-      configParam = JSON.parse(fs.readFileSync(configFilePath, 'utf-8'))
-    } else {
-      configFilePath = path.resolve(node.getNodePath(), '../../hmrouter_config.json')
-      if (fs.existsSync(configFilePath)) {
-        configParam = JSON.parse(fs.readFileSync(configFilePath, 'utf-8'))
-      } else {
-        configParam = {}
-      }
-    }
-  }
-  return new HMRouterPluginConfig(node.getNodeName(), node.getNodePath(), configParam)
-}
-
-export function hapPlugin(): HvigorPlugin {
-  return {
-    pluginId: HAP_PLUGIN_ID,
-    apply(node: HvigorNode) {
-      HMRouterPlugin(node, OhosPluginId.OHOS_HAP_PLUGIN)
-    }
-  }
-}
-
-export function hspPlugin(): HvigorPlugin {
-  return {
-    pluginId: HSP_PLUGIN_ID,
-    apply(node: HvigorNode) {
-      HMRouterPlugin(node, OhosPluginId.OHOS_HSP_PLUGIN)
-    }
-  }
-}
-
-export function harPlugin(): HvigorPlugin {
-  return {
-    pluginId: HAR_PLUGIN_ID,
-    apply(node: HvigorNode) {
-      HMRouterPlugin(node, OhosPluginId.OHOS_HAR_PLUGIN)
-    }
-  }
-}
-
-function HMRouterPluginTask(
-  context: OhosModuleContext,
-  conf: HMRouterPluginConfig,
-  node: HvigorNode
-) {
-  let startTime = Date.now()
-  Logger.log(node.getNodeName() + ' :HMRouterPluginTask start---' + startTime)
-  modulePathArr.push(node.getNodePath())
-  const plugin = new HMRouterHvigorPlugin(conf)
-  plugin.analyzeAnnotation()
-  const buildProfileOpt = context.getBuildProfileOpt()
-  const moduleJsonOpt = context.getModuleJsonOpt()
-  if (moduleJsonOpt.module.routerMap) {
-    let routerMapFileName = moduleJsonOpt.module.routerMap.split(':')[1]
-    let jsonObj = fs.readFileSync(
-      node.getNodePath().replace(/\\/g, '/') +
-        `/src/main/resources/base/profile/${routerMapFileName}.json`,
-      'utf-8'
-    )
-    plugin.routerMap.unshift(...(JSON.parse(jsonObj)['routerMap'] as Array<RouterInfo>))
-  }
-  let routerMap = plugin.generateRouterMap()
-  if (!buildProfileOpt.buildOption?.arkOptions) {
-    buildProfileOpt.buildOption!.arkOptions = {
-      runtimeOnly: {
-        sources: []
-      },
-      buildProfileFields: {
-        HMRouterHash: Date.now()
-      }
-    }
-    pushRouterInfo(buildProfileOpt, routerMap)
-  } else {
-    if (!buildProfileOpt.buildOption.arkOptions.runtimeOnly) {
-      buildProfileOpt.buildOption.arkOptions.runtimeOnly = {
-        sources: []
-      }
-      pushRouterInfo(buildProfileOpt, routerMap)
-    } else {
-      if (!buildProfileOpt.buildOption.arkOptions.runtimeOnly.sources) {
-        buildProfileOpt.buildOption.arkOptions.runtimeOnly.sources = []
-        pushRouterInfo(buildProfileOpt, routerMap)
-      } else {
-        pushRouterInfo(buildProfileOpt, routerMap)
-      }
-    }
-
-    if (!buildProfileOpt.buildOption.arkOptions.buildProfileFields) {
-      buildProfileOpt.buildOption.arkOptions.buildProfileFields = {
-        HMRouterHash: Date.now()
-      }
-    } else {
-      // @ts-ignore
-      buildProfileOpt.buildOption.arkOptions.buildProfileFields.HMRouterHash = Date.now()
-    }
-  }
-
-  moduleJsonOpt.module.routerMap = `$profile:hm_router_map`
-  context.setModuleJsonOpt(moduleJsonOpt)
-  context.setBuildProfileOpt(buildProfileOpt)
-  Logger.log(levels.DEBUG, JSON.stringify(context.getBuildProfileOpt()))
-  let endTime = Date.now()
-  Logger.log(node.getNodeName() + ' :HMRouterPluginTask end---' + endTime)
-  Logger.log(node.getNodeName() + ' :HMRouterPluginTask cost---' + (endTime - startTime) + 'ms')
-}
-
-function pushRouterInfo(buildProfileOpt: any, routerMap: RouterInfo[]) {
-  routerMap.forEach((item: RouterInfo) => {
-    if (item.name.includes('_')) {
-      buildProfileOpt.buildOption!.arkOptions!.runtimeOnly!.sources!.push(
-        './' + item.pageSourceFile
-      )
-    }
-  })
-}
-
-export function deleteGeneratorFile(conf: HMRouterPluginConfig) {
-  if (conf.saveGeneratedFile) {
-    Logger.info('saveGeneratedFile is true, do not delete file')
-    return
-  }
-  Logger.info('deleteGeneratorFile exec...', modulePathArr)
-  for (let modulePath of modulePathArr) {
-    if (fs.existsSync(modulePath + '/' + conf.routerMapDir + '/hm_router_map.json')) {
-      fs.unlinkSync(modulePath + '/' + conf.routerMapDir + '/hm_router_map.json')
-      Logger.log(modulePath + 'delete hm_router_map.json')
-    }
-    if (fs.existsSync(modulePath + '/' + conf.builderDir)) {
-      fs.rmSync(modulePath + '/' + conf.builderDir, {
-        recursive: true
-      })
-      Logger.log(modulePath + 'delete builder dir')
-    }
-  }
-  modulePathArr = []
-}
-
-function HMRouterPlugin(node: HvigorNode, pluginId: string) {
-  Logger.info(`Exec ${pluginId}..., node:${node.getNodeName()}, nodePath:${node.getNodePath()}`)
-  hvigor.nodesEvaluated(async () => {
-    let conf = readConfig(node)
-    if (pluginId === OhosPluginId.OHOS_HAP_PLUGIN) {
-      let packageJson = await Json5Reader.readJson5File(
-        path.resolve(node.getNodePath(), './oh-package.json5'),
-        'utf-8'
-      )
-      conf.moduleName = packageJson.name
-    }
-    const context = node.getContext(pluginId) as ContextLike
-    if (!context) {
-      Logger.error(`errorCode: 40000005, errorMsg: context is null 请检查插件的hvigorfile配置`)
-      deleteGeneratorFile(conf)
-      throw new Error('hspContext is null')
-    }
-    context.targets((target: Target) => {
-      const targetName = target.getTargetName()
-      node.registerTask({
-        name: `${targetName}@HMRouterPLuginTask`,
-        run: () => {
-          HMRouterPluginTask(context, conf, node)
-          let taskName = 'Package' + pluginId.split('.')[2].charAt(0).toUpperCase() + pluginId.split('.')[2].slice(1)
-          node.getTaskByName(`${targetName}@${taskName}`)?.afterRun(() => {
-            deleteGeneratorFile(conf)
-          })
-        },
-        dependencies: [`${targetName}@PreBuild`],
-        postDependencies: [`${targetName}@MergeProfile`]
-      })
-    })
-  })
-}

package/src/PluginModel.ts

@@ -1,50 +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
-export class BaseAnalyzeResult {
-  name?: string // 类名
-  module?: string // 模块名
-  annotation?: string // 注解
-}
-
-export class HMRouterResult extends BaseAnalyzeResult {
-  pageUrl?: string // 跳转路径
-  dialog?: boolean // 是否弹窗
-  singleton?: boolean // 是否单例
-  interceptors?: string[] // 拦截器
-  animator?: string // 动画
-  lifecycle?: string // 生命周期
-}
-
-export class HMAnimatorResult extends BaseAnalyzeResult {
-  animatorName?: string // 动画名称
-}
-
-export class HMInterceptorResult extends BaseAnalyzeResult {
-  interceptorName?: string // 拦截器名称
-  priority?: number // 优先级
-  global?: boolean // 是否全局
-}
-
-export class HMLifecycleResult extends BaseAnalyzeResult {
-  lifecycleName?: string // 生命周期名称
-  priority?: number // 优先级
-  global?: boolean // 是否全局
-}

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/**/*"]
-}

package/viewBuilder.tpl

@@ -1,97 +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.
- */
-
-// auto-generated {{componentName}}Builder.ets
-import { {{componentName}} } from '{{importPath}}'
-import { TemplateMgr, TranslateOption, ScaleOption, OpacityOption } from '@hadss/hmrouter'
-
-@Builder
-export function {{componentName}}Builder(name: string, param: Object) {
-  {{componentName}}Generated()
-}
-
-@Component
-export struct {{componentName}}Generated {
-  @State translateOption: TranslateOption = new TranslateOption()
-  @State scaleOption: ScaleOption = new ScaleOption()
-  @State opacityOption: OpacityOption = new OpacityOption()
-  private pageUrl: string = '{{pageUrl}}'
-  private ndId: string = ''
-
-  aboutToAppear(): void {
-    TemplateMgr.registerAnimatorHandle(this.pageUrl, this.translateOption, this.scaleOption, this.opacityOption)
-    TemplateMgr.registerHMLifecycleHandle(this.pageUrl, this.getUIContext())
-  }
-
-  aboutToDisappear(): void {
-    TemplateMgr.unRegisterAnimatorHandle(this.ndId)
-    TemplateMgr.destroyHMLifecycle(this.pageUrl, this.ndId)
-  }
-
-  build() {
-    NavDestination() {
-      {{componentName}}()
-    }
-    .mode({{dialog}}?NavDestinationMode.DIALOG:NavDestinationMode.STANDARD)
-    .hideTitleBar(true)
-    .gesture(PanGesture()
-      .onActionStart((event: GestureEvent) => {
-        TemplateMgr.interactiveStart(this.ndId, event)
-      })
-      .onActionUpdate((event: GestureEvent) =>{
-        TemplateMgr.interactiveProgress(this.ndId, event)
-      })
-      .onActionEnd((event: GestureEvent) =>{
-        TemplateMgr.interactiveFinish(this.ndId, event)
-      })
-    )
-    .translate(this.translateOption)
-    .scale(this.scaleOption)
-    .opacity(this.opacityOption.opacity)
-    .onAppear(() => {
-      TemplateMgr.onAppear(this.pageUrl, this.ndId)
-    })
-    .onDisAppear(() => {
-      TemplateMgr.onDisAppear(this.pageUrl, this.ndId)
-    })
-    .onShown(() => {
-      TemplateMgr.onShown(this.pageUrl, this.ndId)
-    })
-    .onHidden(() => {
-      TemplateMgr.onHidden(this.pageUrl, this.ndId)
-    })
-    .onWillAppear(() => {
-      TemplateMgr.onWillAppear(this.pageUrl)
-    })
-    .onWillDisappear(() => {
-      TemplateMgr.onWillDisappear(this.pageUrl, this.ndId)
-    })
-    .onWillShow(() => {
-      TemplateMgr.onWillShow(this.pageUrl, this.ndId)
-    })
-    .onWillHide(() => {
-      TemplateMgr.onWillHide(this.pageUrl, this.ndId)
-    })
-    .onReady((navContext: NavDestinationContext) => {
-      this.ndId = navContext.navDestinationId!
-      TemplateMgr.updateAnimatorHandle(this.pageUrl, this.ndId)
-      TemplateMgr.updateLifecycleNavContext(this.pageUrl, navContext)
-      TemplateMgr.onReady(this.pageUrl, this.ndId)
-    })
-    .onBackPressed(() => {
-      return TemplateMgr.onBackPressed(this.pageUrl, this.ndId)
-    })
-  }
-}