@hadss/turbo-trans-json-plugin 1.0.0-rc.0

package/src/core/import-rewrite/strategies/ImportScanStrategy.ts

@@ -0,0 +1,303 @@
+/*
+ * Copyright (c) 2025 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 { ImportDeclaration } from 'ts-morph';
+import { ITaskContext } from '../..';
+import { GeneratedFileInfo, ImportScanStrategy } from '../types/ImportRewriteTypes';
+import { Logger } from '../../logger/Logger';
+import { PathConstants } from '../../constants';
+import SerializationPathUtil from '../../utils/SerializationPathUtil';
+
+export class ImportScanStrategyImpl implements ImportScanStrategy {
+  shouldRewriteImport(
+    importDeclaration: ImportDeclaration,
+    currentFilePath: string,
+    generatedFileInfos: GeneratedFileInfo[],
+    context: ITaskContext
+  ): GeneratedFileInfo | null {
+    const moduleSpecifier = importDeclaration.getModuleSpecifierValue();
+    const importedTypes = this.extractImportedTypes(importDeclaration);
+
+    // 跳过类型定义文件的导入重写
+    if (this.isTypeDefinitionFile(currentFilePath, generatedFileInfos)) {
+      return null;
+    }
+
+    // 检查是否需要重写导入
+    const matchedInfo = this.resolveModuleSpecifier(
+      moduleSpecifier,
+      currentFilePath,
+      generatedFileInfos,
+      context
+    );
+
+    if (matchedInfo) {
+      // 检查导入的类型是否在生成的类列表中
+      const matchedTypes = importedTypes.filter(typeName =>
+        matchedInfo.classNames.has(typeName)
+      );
+
+      if (matchedTypes.length > 0) {
+        return matchedInfo;
+      }
+    }
+
+    return null;
+  }
+
+  /**
+   * 从导出声明检查是否需要重写
+   * 与导入检查逻辑相同，但导出不需要检查导出的类型
+   */
+  shouldRewriteExport(
+    moduleSpecifier: string,
+    currentFilePath: string,
+    generatedFileInfos: GeneratedFileInfo[],
+    context: ITaskContext
+  ): GeneratedFileInfo | null {
+    // 没有 moduleSpecifier 说明没有 from 子句，不需要处理
+    if (!moduleSpecifier) {
+      return null;
+    }
+
+    // 跳过类型定义文件的导出重写
+    if (this.isTypeDefinitionFile(currentFilePath, generatedFileInfos)) {
+      return null;
+    }
+
+    // 使用相同的模块定位逻辑
+    return this.resolveModuleSpecifier(
+      moduleSpecifier,
+      currentFilePath,
+      generatedFileInfos,
+      context
+    );
+  }
+
+  /**
+   * 统一的模块定位逻辑
+   * 支持相对路径导入和模块化导入（包括旧包名）
+   * 复用于 import 和 export 语句
+   */
+  private resolveModuleSpecifier(
+    moduleSpecifier: string,
+    currentFilePath: string,
+    generatedFileInfos: GeneratedFileInfo[],
+    context: ITaskContext
+  ): GeneratedFileInfo | null {
+    // 1. 先尝试处理相对路径导入
+    if (this.isRelativeImport(moduleSpecifier)) {
+      const resolvedSourcePath = this.resolveImportPath(moduleSpecifier, currentFilePath);
+
+      // 在生成信息中查找匹配的源文件
+      for (const generatedInfo of generatedFileInfos) {
+        if (this.pathMatches(resolvedSourcePath, generatedInfo.sourceFilePath)) {
+          return generatedInfo;
+        }
+      }
+
+      return null;
+    }
+
+    // 2. 然后尝试处理模块化导入（包括旧包名）
+    return this.resolveModularImportToSourceFile(
+      moduleSpecifier,
+      generatedFileInfos,
+      context
+    );
+  }
+
+  /**
+   * 从模块化导入路径反推源文件
+   * 核心逻辑：不依赖包名，只匹配文件路径后缀
+   *
+   * 例如：
+   *   导入: 'sampleentry/ets/model/Person'
+   *   源文件相对路径: 'src/main/ets/model/Person'
+   *   提取文件路径: 'ets/model/Person'
+   *   检查后缀匹配: true ✓
+   */
+  private resolveModularImportToSourceFile(
+    moduleSpecifier: string,
+    generatedFileInfos: GeneratedFileInfo[],
+    context: ITaskContext
+  ): GeneratedFileInfo | null {
+    // 1. 提取文件路径部分（去掉包名）
+    const filePath = this.extractFilePathFromModularImport(moduleSpecifier);
+    if (!filePath) {
+      return null;
+    }
+
+    // 2. 遍历所有源文件，尝试匹配
+    for (const info of generatedFileInfos) {
+      // 获取源文件的相对路径
+      const sourceFileRelativePath = context.calculateSourceRootToModuleRoot(info.sourceFilePath);
+
+      // 移除扩展名
+      const pathWithoutExtension = this.removeFileExtension(sourceFileRelativePath);
+
+      // 统一分隔符为 /
+      const normalizedSourcePath = pathWithoutExtension.replaceAll(SerializationPathUtil.sep, '/');
+
+      // 检查是否为后缀匹配
+      if (this.isPathSuffix(filePath, normalizedSourcePath)) {
+        Logger.debug(`模块化导入 '${moduleSpecifier}' 匹配源文件: ${info.sourceFilePath}`);
+        return info;
+      }
+    }
+
+    return null;
+  }
+
+  /**
+   * 从模块化导入提取文件路径部分
+   *
+   * 例如：
+   *   'sampleentry/ets/model/Person' -> 'ets/model/Person'
+   *   '@hadss/pkg/ets/model/Person' -> 'ets/model/Person'
+   *   'invalid' -> null
+   */
+  private extractFilePathFromModularImport(moduleSpecifier: string): string | null {
+    const parts = moduleSpecifier.split('/');
+
+    if (parts.length < 2) {
+      return null;
+    }
+
+    // 确定包名占几个部分
+    let filePathStartIndex = 1;
+    if (parts[0].startsWith('@')) {
+      // 作用域包：@org/package
+      filePathStartIndex = 2;
+    }
+
+    if (filePathStartIndex >= parts.length) {
+      // 没有文件路径部分
+      return null;
+    }
+
+    return parts.slice(filePathStartIndex).join('/');
+  }
+
+  /**
+   * 检查 shortPath 是否是 fullPath 的后缀
+   *
+   * 例如：
+   *   isPathSuffix('ets/model/Person', 'src/main/ets/model/Person') -> true
+   *   isPathSuffix('model/Person', 'src/main/ets/model/Person') -> true
+   *   isPathSuffix('ets/model/Person', 'src/main/ets/data/Person') -> false
+   */
+  private isPathSuffix(shortPath: string, fullPath: string): boolean {
+    const shortParts = shortPath.split('/').filter(p => p.length > 0);
+    const fullParts = fullPath.split('/').filter(p => p.length > 0);
+
+    // 如果短路径更长，不可能是后缀
+    if (shortParts.length > fullParts.length) {
+      return false;
+    }
+
+    // 从后向前匹配
+    const offset = fullParts.length - shortParts.length;
+    for (let i = 0; i < shortParts.length; i++) {
+      if (shortParts[i] !== fullParts[offset + i]) {
+        return false;
+      }
+    }
+
+    return true;
+  }
+
+  /**
+   * 移除文件扩展名
+   */
+  private removeFileExtension(filePath: string): string {
+    const lastDotIndex = filePath.lastIndexOf('.');
+    if (lastDotIndex > 0) {
+      return filePath.substring(0, lastDotIndex);
+    }
+    return filePath;
+  }
+
+  /**
+   * 检查文件是否为类型定义文件
+   * 类型定义文件是指包含 @Serializable 类且生成了序列化代码的源文件
+   */
+  private isTypeDefinitionFile(filePath: string, generatedFileInfos: GeneratedFileInfo[]): boolean {
+    return generatedFileInfos.some(info => info.sourceFilePath === filePath);
+  }
+
+  /**
+   * 检查是否为相对路径导入
+   */
+  private isRelativeImport(moduleSpecifier: string): boolean {
+    return moduleSpecifier.startsWith('./') || moduleSpecifier.startsWith('../');
+  }
+
+  /**
+   * 解析导入路径为绝对路径
+   * '../model/Person' + '/project/src/main/ets/features/EntityClass.ets'
+   * -> '/project/src/main/ets/model/Person.ets'
+   */
+  private resolveImportPath(moduleSpecifier: string, currentFilePath: string): string {
+    if (this.isRelativeImport(moduleSpecifier)) {
+      const currentDir = SerializationPathUtil.dirname(currentFilePath);
+      const resolvedPath = SerializationPathUtil.pathResolve(currentDir, moduleSpecifier);
+
+      // 如果没有扩展名，添加 .ets
+      if (!SerializationPathUtil.extname(resolvedPath)) {
+        return resolvedPath + PathConstants.ETS_EXTENSIONS;
+      }
+      return resolvedPath;
+    }
+    return moduleSpecifier;
+  }
+
+  /**
+   * 路径匹配检查（处理路径标准化）
+   */
+  private pathMatches(resolvedPath: string, sourcePath: string): boolean {
+    const normalizedResolved = SerializationPathUtil.pathResolve(resolvedPath);
+    const normalizedSource = SerializationPathUtil.pathResolve(sourcePath);
+    return normalizedResolved === normalizedSource;
+  }
+
+  /**
+   * 从导入声明中提取导入的类型名
+   */
+  private extractImportedTypes(importDeclaration: ImportDeclaration): string[] {
+    const importedTypes: string[] = [];
+
+    // 处理命名导入: import { Person, User } from './model'
+    const namedImports = importDeclaration.getNamedImports();
+    for (const namedImport of namedImports) {
+      importedTypes.push(namedImport.getName());
+    }
+
+    // 处理默认导入: import Person from './Person'
+    const defaultImport = importDeclaration.getDefaultImport();
+    if (defaultImport) {
+      importedTypes.push(defaultImport.getText());
+    }
+
+    // 处理命名空间导入: import * as Models from './models'
+    const namespaceImport = importDeclaration.getNamespaceImport();
+    if (namespaceImport) {
+      // 对于命名空间导入，我们暂时不处理，因为这种情况比较复杂
+      Logger.warn(`跳过命名空间导入: ${namespaceImport.getText()}`);
+    }
+
+    return importedTypes;
+  }
+}

package/src/core/import-rewrite/types/ImportRewriteTypes.ts

@@ -0,0 +1,100 @@
+/*
+ * Copyright (c) 2025 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 { ImportDeclaration } from 'ts-morph';
+import { ITaskContext, ImportRewriteOptions } from '../..';
+
+/**
+ * 生成文件信息映射
+ * 包含源文件到生成文件的完整映射关系
+ */
+export interface GeneratedFileInfo {
+  sourceFilePath: string;         // 源文件绝对路径
+  generatedFilePath: string;      // 生成文件绝对路径
+  classNames: Set<string>;        // 该文件中包含的类名列表
+}
+
+/**
+ * 导入重写服务接口
+ */
+export interface ImportRewriteService {
+  /**
+   * 重写项目中的导入语句
+   * @param context 任务上下文 (ITaskContext)
+   * @param generatedFileInfos 生成文件信息列表
+   * @param options 导入重写选项
+   */
+  rewriteImports(
+    context: ITaskContext,
+    generatedFileInfos: GeneratedFileInfo[],
+    options: ImportRewriteOptions
+  ): void;
+}
+
+/**
+ * 导入扫描策略接口
+ */
+export interface ImportScanStrategy {
+  /**
+   * 基于实际生成信息进行精确匹配
+   * 只有实际生成了序列化代码的类才会被重写导入
+   *
+   * @param importDeclaration 导入声明
+   * @param currentFilePath 当前文件路径
+   * @param generatedFileInfos 生成文件信息列表
+   * @param context 任务上下文，用于解析文件路径
+   */
+  shouldRewriteImport(
+    importDeclaration: ImportDeclaration,
+    currentFilePath: string,
+    generatedFileInfos: GeneratedFileInfo[],
+    context: ITaskContext
+  ): GeneratedFileInfo | null;
+
+  /**
+   * 检查导出声明是否需要重写
+   * 与导入检查逻辑相同
+   *
+   * @param moduleSpecifier 导出的模块说明符（from 子句的值）
+   * @param currentFilePath 当前文件路径
+   * @param generatedFileInfos 生成文件信息列表
+   * @param context 任务上下文，用于解析文件路径
+   */
+  shouldRewriteExport(
+    moduleSpecifier: string,
+    currentFilePath: string,
+    generatedFileInfos: GeneratedFileInfo[],
+    context: ITaskContext
+  ): GeneratedFileInfo | null;
+}
+
+/**
+ * 导入转换服务接口
+ */
+export interface ImportTransformService {
+  /**
+   * 重写文件中的导入语句
+   * @param filePath 文件路径
+   * @param context 任务上下文
+   * @param generatedFileInfos 生成文件信息列表
+   * @param preserveOriginalImports 是否保留原导入注释
+   */
+  rewriteFileImports(
+    filePath: string,
+    context: ITaskContext,
+    generatedFileInfos: GeneratedFileInfo[],
+    preserveOriginalImports?: boolean
+  ): void;
+}

package/src/core/index.ts

@@ -0,0 +1,31 @@
+/*
+ * Copyright (c) 2025 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 * from './interfaces'
+
+export * from './logger/Logger';
+
+export * from './constants'
+
+export * from './Types';
+
+export * from './services/CodeGenerationEngine'
+
+// 导入重写功能导出
+export * from './import-rewrite/types/ImportRewriteTypes';
+export * from './import-rewrite/services/ImportRewriteService';
+export * from './utils/ConfigManager';
+
+export { TempSerializerGenerator } from './services/CodeGenerationService/generators/TempSerializerGenerator'

package/src/core/interfaces/ITask.ts

@@ -0,0 +1,23 @@
+/*
+ * Copyright (c) 2025 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 { ITaskContext } from './ITaskContext'
+
+export interface ITask {
+  readonly taskName: string
+  readonly dependencies: string[]
+  readonly postDependencies: string[]
+  run(context: ITaskContext): void | Promise<void>
+}

package/src/core/interfaces/ITaskContext.ts

@@ -0,0 +1,94 @@
+/*
+ * Copyright (c) 2025 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 interface ITaskContext {
+  /**
+   * 将源文件路径映射为输出文件路径
+   * @param absSourceFile 源文件的绝对路径
+   * @returns 输出文件的绝对路径
+   * @example
+   * 'module/src/main/ets/User.ets' -> '/module/src/generated/ets/User.ets'
+   */
+  mapToOutputPath(absSourceFile: string): string
+
+  /**
+   * 获取输出根目录
+   * 返回所有生成文件的根目录路径
+   * @returns 输出根目录的绝对路径
+   * @example
+   * 'module/src/generated'
+   */
+  getOutputRoot(): string
+
+  /**
+   * 获取模块名称
+   * 返回当前模块module.json5中配置的name字段
+   * @returns 输出当前模块module.json5中配置的name字段
+   */
+  getModuleName(): string
+
+  /**
+   * 获取模块根路径
+   * @returns 输出当前模块根路径
+   */
+  getModulePath(): string
+
+  /**
+   * 获取package名称
+   * 返回当前模块oh-package.json5中配置的name字段
+   * @returns 输出当前模块oh-package.json5中配置的name字段
+   */
+  getPackageName(): string
+
+  /**
+   * 获取文件的相对路径
+   * 将绝对路径转换为相对于项目根目录的路径
+   * 主要用于日志显示和错误报告
+   * @param absolutePath 绝对文件路径
+   * @returns 相对于项目根目录的路径
+   * @example
+   * 'module/src/main/ets/User.ets' -> 'src/main/ets/User.ets'
+   */
+  getRelativePath(absolutePath: string): string
+
+  /**
+   * 检查输出路径是否有效
+   * 验证输出路径是否满足当前环境的要求
+   * 用于路径映射的安全性检查
+   * @param outputPath 输出文件路径
+   * @returns 路径是否有效
+   */
+  isValidOutputPath(outputPath: string): boolean
+
+  /**
+   * 确保输出目录存在
+   * 创建输出文件所需的目录结构
+   * @param outputPath 输出文件路径
+   * @returns Promise<void>
+   */
+  ensureOutputDirectory(outputPath: string): void
+
+
+  /**
+   * 计算相对于模块根目录的路径
+   * 剔除sourceRoots路径前缀，默认包含 './src/main'
+   *
+   * @param absolutePath 文件的绝对路径
+   * @returns 相对于模块根的路径（剔除src/main或src/generated前缀）
+   * @example
+   * 'module/src/main/ets/User.ets' -> '/ets/User.ets'
+   */
+  calculateSourceRootToModuleRoot(absolutePath: string): string
+}

package/src/core/interfaces/index.ts

@@ -0,0 +1,17 @@
+/*
+ * Copyright (c) 2025 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 { ITask } from './ITask'
+export { ITaskContext } from './ITaskContext';