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

package/src/HMRouterAnalyzer.ts

@@ -1,253 +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 ts from 'typescript'
-import fs from 'fs'
-import { HMRouterPluginConfig } from './HMRouterPluginConfig'
-import {
-  AnalyzerResultLike,
-  HMAnimatorResult,
-  HMInterceptorResult,
-  HMLifecycleResult,
-  HMRouterResult
-} from './PluginModel'
-import { HvigorLogger } from '@ohos/hvigor'
-import { deleteGeneratorFile } from './Index'
-
-class NodeInfo {
-  value?: any
-}
-
-const Logger = HvigorLogger.getLogger()
-
-export class Analyzer {
-  customAnnotationExisted: boolean = false
-  analyzeResultMap: Map<string, AnalyzerResultLike> = new Map()
-  private sourcePath: string
-  private pluginConfig: HMRouterPluginConfig
-  private analyzeResult: AnalyzerResultLike = {}
-  private keywordPos: number = 0
-
-  constructor(sourcePath: string, pluginConfig: HMRouterPluginConfig) {
-    this.sourcePath = sourcePath
-    this.pluginConfig = pluginConfig
-  }
-
-  start() {
-    const sourceCode = fs.readFileSync(this.sourcePath, 'utf-8')
-    const sourceFile = ts.createSourceFile(
-      this.sourcePath,
-      sourceCode,
-      ts.ScriptTarget.ES2021,
-      false
-    )
-    ts.forEachChild(sourceFile, node => {
-      this.resolveNode(node)
-      // 解析完成后赋值存进Map
-      switch (this.analyzeResult.annotation) {
-        case 'HMRouter':
-          this.analyzeResultMap.set(
-            (this.analyzeResult as HMRouterResult).pageUrl!,
-            this.analyzeResult
-          )
-          break
-        case 'HMAnimator':
-          this.analyzeResultMap.set(
-            (this.analyzeResult as HMAnimatorResult).animatorName!,
-            this.analyzeResult
-          )
-          break
-        case 'HMInterceptor':
-          this.analyzeResultMap.set(
-            (this.analyzeResult as HMInterceptorResult).interceptorName!,
-            this.analyzeResult
-          )
-          break
-        case 'HMLifecycle':
-          this.analyzeResultMap.set(
-            (this.analyzeResult as HMLifecycleResult).lifecycleName!,
-            this.analyzeResult
-          )
-          break
-      }
-    })
-  }
-
-  private resolveNode(node: ts.Node) {
-    if (ts.isMissingDeclaration(node)) {
-      this.resolveMissingDeclaration(node)
-    } else if (ts.isClassDeclaration(node)) {
-      this.resolveClass(node)
-    } else if (ts.isDecorator(node)) {
-      this.resolveDecorator(node)
-    } else if (ts.isCallExpression(node)) {
-      this.resolveCallExpression(node)
-    } else if (ts.isExpressionStatement(node)) {
-      this.resolveExpression(node)
-    } else if (ts.isBlock(node)) {
-      this.resolveBlock(node)
-    } else if (ts.isPropertyAssignment(node)) {
-      return this.resolvePropertyAccess(node)
-    } else if (ts.isIdentifier(node)) {
-      return this.resolveIdentifier(node)
-    } else if (ts.isStringLiteral(node)) {
-      return this.resolveStringLiteral(node)
-    } else if (node.kind === ts.SyntaxKind.TrueKeyword) {
-      let info = new NodeInfo()
-      info.value = true
-      return info
-    } else if (node.kind === ts.SyntaxKind.FalseKeyword) {
-      let info = new NodeInfo()
-      info.value = false
-      return info
-    } else if (ts.isNumericLiteral(node)) {
-      return this.resolveNumericLiteral(node)
-    } else if (ts.isArrayLiteralExpression(node)) {
-      let interceptors = this.resolveArrayLiteral(node)
-      let info = new NodeInfo()
-      info.value = interceptors
-      return info
-    }
-  }
-
-  private resolveMissingDeclaration(node: ts.MissingDeclaration) {
-    this.analyzeResult = {}
-    node.forEachChild(child => this.resolveNode(child))
-  }
-
-  private resolveClass(node: ts.ClassDeclaration) {
-    // 解析到类声明，先清空一次返回结果
-    this.analyzeResult = {}
-    node.modifiers?.forEach(modifier => {
-      // 遍历分析装饰器
-      this.resolveNode(modifier)
-    })
-    if (this.customAnnotationExisted) {
-      this.analyzeResult.name = node.name?.text
-    }
-  }
-
-  private resolveDecorator(node: ts.Decorator) {
-    if (ts.isCallExpression(node.expression)) {
-      const callExpression = node.expression as ts.CallExpression
-      if (ts.isIdentifier(callExpression.expression)) {
-        this.switchIdentifier(callExpression)
-      }
-    }
-  }
-
-  private switchIdentifier(callExpression: ts.CallExpression) {
-    const identifier = callExpression.expression as ts.Identifier
-    if (this.pluginConfig.annotation.some(item => item === identifier.text)) {
-      this.customAnnotationExisted = true
-      // 区分是什么装饰器，构造不同的返回类
-      switch (identifier.text) {
-        case 'HMRouter':
-          this.analyzeResult = new HMRouterResult()
-          this.analyzeResult.annotation = 'HMRouter'
-          break
-        case 'HMAnimator':
-          this.analyzeResult = new HMAnimatorResult()
-          this.analyzeResult.annotation = 'HMAnimator'
-          break
-        case 'HMInterceptor':
-          this.analyzeResult = new HMInterceptorResult()
-          this.analyzeResult.annotation = 'HMInterceptor'
-          break
-        case 'HMLifecycle':
-          this.analyzeResult = new HMLifecycleResult()
-          this.analyzeResult.annotation = 'HMLifecycle'
-          break
-      }
-      if (callExpression.arguments.length > 0) {
-        this.resolveCallExpression(callExpression)
-      }
-    }
-  }
-
-  private resolveCallExpression(node: ts.CallExpression) {
-    let identifier = this.resolveNode(node.expression)
-    this.parseAnnotation(node.arguments, identifier)
-  }
-
-  private resolveExpression(node: ts.ExpressionStatement) {
-    let identifier = this.resolveNode(node.expression)
-    if (identifier?.value === 'struct') {
-      this.keywordPos = node.end
-    }
-    if (this.analyzeResult.annotation === 'HMRouter' && this.keywordPos === node.pos) {
-      this.analyzeResult.name = identifier?.value
-    }
-  }
-
-  private resolveBlock(node: ts.Block) {
-    node.statements.forEach(statement => {
-      this.resolveNode(statement)
-    })
-  }
-
-  private parseAnnotation(args: ts.NodeArray<ts.Expression>, nodeInfo?: NodeInfo) {
-    if (this.pluginConfig.annotation.some(item => nodeInfo?.value === item)) {
-      args
-        .flatMap((e: ts.Expression) => (e as ts.ObjectLiteralExpression).properties)
-        .forEach((e: ts.ObjectLiteralElementLike) => {
-          this.parseConfig(e, this.analyzeResult)
-        })
-    }
-  }
-
-  private parseConfig(node: ts.ObjectLiteralElementLike, result: AnalyzerResultLike) {
-    let info = this.resolveNode(node)
-    Reflect.set(result, info?.value['key'], info?.value['value'])
-  }
-
-  private resolveArrayLiteral(node: ts.ArrayLiteralExpression) {
-    return node.elements.map(e => this.resolveNode(e)?.value as string)
-  }
-
-  private resolvePropertyAccess(node: ts.PropertyAssignment) {
-    let propertyName = this.resolveNode(node.name)?.value
-    let propertyValue = this.resolveNode(node.initializer)?.value
-    let info = new NodeInfo()
-    info.value = { key: propertyName, value: propertyValue }
-    return info
-  }
-
-  private resolveNumericLiteral(node: ts.NumericLiteral) {
-    let info = new NodeInfo()
-    info.value = Number(node.text)
-    return info
-  }
-
-  private resolveStringLiteral(node: ts.StringLiteral) {
-    let info = new NodeInfo()
-    info.value = node.text
-    return info
-  }
-
-  private resolveIdentifier(node: ts.Identifier) {
-    if (node.escapedText === 'NavDestination' && this.analyzeResult.annotation === 'HMRouter') {
-      Logger.error(
-        'errorCode: 40000003, errorMsg: @HMRouter 修饰的组件不能包含 NavDestination in' +
-          this.analyzeResult.name
-      )
-      deleteGeneratorFile(this.pluginConfig)
-      throw new Error('NavDestination is not allowed in HMRouter' + this.sourcePath)
-    }
-    let info = new NodeInfo()
-    info.value = node.escapedText.toString()
-    return info
-  }
-}

package/src/HMRouterHvigorPlugin.ts

@@ -1,246 +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'
-import { HMRouterPluginConfig } from './HMRouterPluginConfig'
-import {
-  AnalyzerResultLike,
-  HMAnimatorResult,
-  HMInterceptorResult,
-  HMLifecycleResult,
-  HMRouterResult
-} from './PluginModel'
-import path from 'path'
-import fs from 'fs'
-import { Analyzer } from './HMRouterAnalyzer'
-import Handlebars from 'handlebars'
-import { deleteGeneratorFile } from './Index'
-
-const Logger = HvigorLogger.getLogger()
-
-interface templateModel {
-  pageUrl: string
-  importPath: string
-  componentName: string
-  dialog: boolean
-  generatorViewName: string
-}
-
-export class RouterInfo {
-  name: string
-  pageSourceFile: string
-  buildFunction: string
-  data: AnalyzerResultLike
-
-  constructor(
-    name: string,
-    pageSourceFile: string,
-    buildFunction: string,
-    data: AnalyzerResultLike = {}
-  ) {
-    this.name = name
-    this.pageSourceFile = pageSourceFile
-    this.buildFunction = buildFunction
-    this.data = data
-  }
-}
-
-export class HMRouterHvigorPlugin {
-  config: HMRouterPluginConfig
-  routerMap: RouterInfo[] = []
-  private scanFiles: string[] = []
-  HMRouterNum: number = 0
-
-  constructor(config: HMRouterPluginConfig) {
-    this.config = config
-  }
-
-  analyzeAnnotation() {
-    const templateModel = {
-      pageUrl: '',
-      importPath: '',
-      componentName: '',
-      dialog: false,
-      generatorViewName: ''
-    }
-
-    this.config.scanDir.forEach(scanDir => {
-      const scanPath = `${this.config.modulePath}/${scanDir}`
-      this.deepScan(scanPath, '')
-    })
-
-    Logger.info(`扫描到${this.scanFiles.length}个文件`, this.scanFiles)
-
-    this.scanFiles.forEach(filePath => {
-      if (filePath.endsWith('.ets')) {
-        const importPath = path
-          .relative(`${this.config.modulePath}/${this.config.builderDir}`, filePath)
-          .replaceAll('\\', '/')
-          .replaceAll('.ets', '')
-
-        const analyzer = new Analyzer(filePath, this.config)
-        analyzer.start()
-        for (let [key, value] of analyzer.analyzeResultMap) {
-          value.module = this.config.moduleName
-          let pageSourceFile = path.relative(this.config.modulePath, filePath).replaceAll('\\', '/')
-          this.pushRouterInfo(value, pageSourceFile, importPath, templateModel)
-        }
-        this.HMRouterNum = 0
-      }
-    })
-  }
-
-  private stringToHashCode(str: string) {
-    let hash = 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位整数
-    }
-    return hash
-  }
-
-  private pushHMRouter(
-    value: AnalyzerResultLike,
-    importPath: string,
-    templateModel: templateModel
-  ) {
-    let analyzeResult = value as HMRouterResult
-    templateModel.pageUrl = analyzeResult.pageUrl as string
-    templateModel.importPath = importPath
-    templateModel.componentName = analyzeResult.name as string
-    templateModel.dialog = !!analyzeResult.dialog
-    templateModel.generatorViewName = 'HM' + analyzeResult.name + this.stringToHashCode(analyzeResult.pageUrl!)
-
-    this.routerMap.push(
-      new RouterInfo(
-        analyzeResult.pageUrl as string,
-        `${this.config.builderDir}/${templateModel.generatorViewName}.ets`,
-        `${templateModel.componentName}Builder`,
-        value
-      )
-    )
-
-    this.generateBuilder(templateModel)
-  }
-
-  private pushRouterInfo(
-    value: AnalyzerResultLike,
-    pageSourceFile: string,
-    importPath: string,
-    templateModel: templateModel
-  ) {
-    switch (value.annotation) {
-      case 'HMRouter':
-        this.HMRouterNum++
-        if (this.HMRouterNum > 1) {
-          Logger.error(`errorCode: 40000004, errorMsg: 文件${pageSourceFile}中存在多个HMRouter注解`)
-          deleteGeneratorFile(this.config)
-          throw new Error(`文件${pageSourceFile}中存在多个HMRouter注解`)
-        }
-        this.pushHMRouter(value, importPath, templateModel)
-        break
-      case 'HMAnimator':
-        this.routerMap.push(
-          new RouterInfo(
-            `__animator__${(value as HMAnimatorResult).animatorName}`,
-            pageSourceFile,
-            '',
-            value
-          )
-        )
-        break
-      case 'HMInterceptor':
-        this.routerMap.push(
-          new RouterInfo(
-            `__interceptor__${(value as HMInterceptorResult).interceptorName}`,
-            pageSourceFile,
-            '',
-            value
-          )
-        )
-        break
-      case 'HMLifecycle':
-        this.routerMap.push(
-          new RouterInfo(
-            `__lifecycle__${(value as HMLifecycleResult).lifecycleName}`,
-            pageSourceFile,
-            '',
-            value
-          )
-        )
-        break
-    }
-  }
-
-  generateBuilder(templateModel: templateModel) {
-    const builderPath = path.resolve(__dirname, '../' + this.config.builderTpl)
-    const tpl = fs.readFileSync(builderPath, { encoding: 'utf-8' })
-    const template = Handlebars.compile(tpl)
-    const output = template(templateModel)
-    const routerBuilderDir = `${this.config.modulePath}/${this.config.builderDir}`
-    if (!fs.existsSync(routerBuilderDir)) {
-      fs.mkdirSync(routerBuilderDir)
-    }
-    fs.writeFileSync(`${routerBuilderDir}/${templateModel.generatorViewName}.ets`, output, {
-      encoding: 'utf-8'
-    })
-    Logger.info(`Builder ${templateModel.generatorViewName}.ets has been generated in ${routerBuilderDir}`)
-  }
-
-  generateRouterMap() {
-    let set = new Set<string>()
-    this.routerMap.forEach(item => {
-      if(set.has(item.name)) {
-        Logger.error(`errorCode: 40000001, errorMsg: 重复的pageUrl、拦截器、生命周期、动画--${item.name}`)
-        deleteGeneratorFile(this.config)
-        throw new Error(`路由${item.name}重复`)
-      } else {
-        set.add(item.name)
-      }
-    })
-    let routerMap = {
-      routerMap: this.routerMap.map(item => {
-        if (item.data && item.data.annotation) { 
-          delete item.data.annotation
-          // @ts-ignore
-          item.data = { data: JSON.stringify(item.data) }
-        }
-        return item
-      })
-    }
-
-    const jsonOutput = JSON.stringify(routerMap, null, 2)
-    const routerMapDir = `${this.config.modulePath}/${this.config.routerMapDir}`
-    if (!fs.existsSync(routerMapDir)) {
-      fs.mkdirSync(routerMapDir, { recursive: true })
-    }
-    fs.writeFileSync(`${routerMapDir}/hm_router_map.json`, jsonOutput, { encoding: 'utf-8' })
-    Logger.info(`hm_router_map.json has been generated in ${routerMapDir}`)
-    return this.routerMap
-  }
-
-  private deepScan(scanPath: string, filePath: string) {
-    if (fs.lstatSync(`${scanPath + filePath}`).isDirectory()) {
-      const files: string[] = fs.readdirSync(`${scanPath}${filePath}`)
-      files.forEach(file => {
-        this.deepScan(`${scanPath}${filePath}/`, file)
-      })
-    } else {
-      this.scanFiles.push(`${scanPath}${filePath}`)
-    }
-  }
-}

package/src/HMRouterPluginConfig.ts

@@ -1,44 +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 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) {
-    this.moduleName = moduleName
-    this.modulePath = modulePath
-    this.scanDir = param.scanDir ? 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']
-    this.builderTpl = param.builderTpl ? param.builderTpl : 'viewBuilder.tpl'
-    this.saveGeneratedFile = !!param.saveGeneratedFile
-  }
-}
-
-export interface HMRouterPluginConfigParam {
-  scanDir?: string[]
-  routerMapDir?: string
-  builderDir?: string
-  saveGeneratedFile?: boolean // 隐藏字段仅用于调试
-  builderTpl?: string // 隐藏字段仅用于调试
-}