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

package/src/json-plugin/tasks/WatchTask.ts

@@ -0,0 +1,99 @@
+/*
+ * 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 * as chokidar from 'chokidar';
+import { Logger } from '../../core';
+import { TaskConstants } from '../constants/TaskConstants';
+import { ITargetContext } from '../interfaces/ITargetContext';
+import { BaseTask } from './BaseTask';
+
+export class WatchTask extends BaseTask {
+  readonly taskName: string = TaskConstants.WATCH_TASK;
+  readonly dependencies: string[] = []; // CLI任务无依赖
+  readonly postDependencies: string[] = []; // CLI任务无依赖
+
+  private watcher?: chokidar.FSWatcher;
+
+  async run(context: ITargetContext): Promise<void> {
+    Logger.info('Start the file listening task');
+
+    const watchPaths = this.getScanFiles(context);
+    if (watchPaths.length === 0) {
+      Logger.info('There are no files to listen to');
+      return;
+    }
+
+    Logger.info(`Start listening for file changes: ${watchPaths.join(', ')}`);
+
+    // 创建文件监听器
+    this.watcher = chokidar.watch(watchPaths, {
+      persistent: true,
+      ignoreInitial: false // 初始时也触发一次
+    });
+
+    // 设置事件监听器
+    this.setupWatchEvents(context);
+
+    Logger.info('File monitoring has been started. Press Ctrl+C to stop the monitoring');
+
+    return new Promise(_resolve => {
+      // 进程会一直运行，直到用户手动停止
+      // resolve永远不会被调用，除非出现错误或用户停止
+    });
+  }
+
+  private setupWatchEvents(context: ITargetContext): void {
+    if (!this.watcher) return
+
+    let debounceTimer: NodeJS.Timeout | null = null
+
+    // 防抖处理，避免频繁触发
+    const debouncedGenerate = (filePath: string) => {
+      if (debounceTimer) {
+        clearTimeout(debounceTimer)
+      }
+      debounceTimer = setTimeout(() => {
+        this.generateCode(filePath, context)
+      }, 500) // 500ms 防抖
+    }
+
+    this.watcher
+      .on('add', (filePath: string) => {
+        Logger.info(`New file detected: ${filePath}`)
+        debouncedGenerate(filePath)
+      })
+      .on('change', (filePath: string) => {
+        Logger.info(`File change detected: ${filePath}`)
+        debouncedGenerate(filePath)
+      })
+      .on('unlink', (filePath: string) => {
+        Logger.info(`File deletion detected: ${filePath}`)
+        debouncedGenerate(filePath)
+      })
+      .on('error', (error: unknown) => {
+        Logger.error(`File monitoring error: ${error}`)
+      })
+      .on('ready', () => {
+        Logger.info('The initial file scan is complete. Start listening for file changes...')
+      })
+  }
+
+  private generateCode(scanFile: string, context: ITargetContext): void {
+    // 统一处理：逐文件分析 → 直接生成
+    const processingResult = this.engine.processFileUnified(scanFile, context)
+
+    Logger.info(`The code generation is complete, and the output path is ${processingResult?.outputPath}`)
+  }
+}

package/template/SerializerPerformanceTemplate.hbs

@@ -0,0 +1,35 @@
+{{! 反序列化方法：简化的默认值处理 }}
+deserialize(decoder: Decoder, plain: ESObject): {{class.className}}{{#if class.generics.isGeneric}}<{{genericParametersString class.generics.parameters}}>{{/if}} {
+  const keys = this.serialDescriptor.elementDecodingNames;
+
+  {{#if (isClassType class)}}
+    {{! 解码构造函数属性（直接反序列化）}}
+    const result = new {{class.className}}{{#if class.generics.isGeneric}}<{{genericParametersString class.generics.parameters}}>{{/if}}(
+    {{#each (getCtorProperties class.constructorParams properties)}}
+      {{#unless analysis.decorators.isTransient}}
+        {{#if (and (eqPrimitiveType analysis.type.kind) (not (hasDecoratorWith analysis.decorators)))}}decoder.{{serializer.decodeMethod}}(plain[keys[{{getPropertyIndex this ../properties}}]]){{else}}this.{{analysis.name}}Serializer.deserialize(decoder, plain[keys[{{getPropertyIndex this ../properties}}]]){{/if}}{{#if serializer.needsTypeAssertion}} as {{analysis.type.sourceText}}{{/if}}{{#unless @last}},{{/unless}}
+      {{/unless}}
+    {{/each}});
+  {{else}}
+    const result: ESObject = {};
+  {{/if}}
+  
+
+  {{! 可选属性赋值（构造函数外的属性）}}
+  {{#each (postConstructorAssignments class.constructorParams properties)}}
+    {{#unless analysis.decorators.isTransient}}
+      const {{analysis.name}}PlainValue: ESObject = plain[keys[{{getPropertyIndex this ../properties}}]];
+      {{#if analysis.defaultValue}}
+      {{! 有默认值的属性 }}
+      result.{{analysis.name}} = {{analysis.name}}PlainValue === undefined ? {{analysis.defaultValue}} :
+        {{#if (and (eqPrimitiveType analysis.type.kind) (not (hasDecoratorWith analysis.decorators)))}}decoder.{{serializer.decodeMethod}}(plain[keys[{{getPropertyIndex this ../properties}}]]){{else}}this.{{analysis.name}}Serializer.deserialize(decoder, plain[keys[{{getPropertyIndex this ../properties}}]]){{/if}}{{#if serializer.needsTypeAssertion}} as {{analysis.type.sourceText}}{{/if}};
+      {{else}}
+      {{! 无默认值的属性 }}
+      result.{{analysis.name}} = {{analysis.name}}PlainValue === undefined ? undefined :
+        {{#if (and (eqPrimitiveType analysis.type.kind) (not (hasDecoratorWith analysis.decorators)))}}decoder.{{serializer.decodeMethod}}(plain[keys[{{getPropertyIndex this ../properties}}]]){{else}}this.{{analysis.name}}Serializer.deserialize(decoder, plain[keys[{{getPropertyIndex this ../properties}}]]){{/if}}{{#if serializer.needsTypeAssertion}} as {{analysis.type.sourceText}}{{/if}};
+      {{/if}}
+    {{/unless}}
+  {{/each}}
+
+  return result as {{class.className}}{{#if class.generics.isGeneric}}<{{genericParametersString class.generics.parameters}}>{{/if}};
+}

package/template/SerializerRegisterTemplate.hbs

@@ -0,0 +1,10 @@
+{{! 类型的需要注册， 接口类型class.className无法作为参数注册 }}
+{{#if (isClassType class)}}
+{{#if class.generics.isGeneric}}
+{{! 工厂注册 }}
+registerAutoGeneratedSerializerEntry({{class.className}}, new {{class.className}}SerializerFactory());
+{{else}}
+{{! 单例注册 }}
+registerAutoGeneratedSerializerEntry({{class.className}}, {{class.className}}Serializer.INSTANCE);
+{{/if}}
+{{/if}}

package/template/SerializerStrictTemplate.hbs

@@ -0,0 +1,89 @@
+{{! 反序列化方法：精确验证和错误处理 }}
+deserialize(decoder: Decoder, plain: ESObject): {{class.className}}{{#if class.generics.isGeneric}}<{{genericParametersString class.generics.parameters}}>{{/if}} {
+  {{! 类型验证 }}
+  if (!TypeUtils.isObject(plain)) {
+    TurboTransLogger.error('Cannot deserialize `{{class.className}}` from non-object serialized data in strict deserialization.')
+    throw new SerializationError(
+      SerializationErrorCodes.CANNOT_BEGIN_STRUCTURE_ON_NON_STRUCTURE_KIND,
+      'Cannot deserialize `{{class.className}}` from non-object serialized data in strict deserialization.'
+    );
+  }
+
+  {{! 属性状态跟踪变量 }}
+  {{#each properties}}
+    let {{analysis.name}}Seen = false;
+    let {{analysis.name}}Value: {{serializer.decoderType}} = undefined;
+  {{/each}}
+
+  {{! Object.entries 遍历 }}
+  const entries: [string, ESObject][] = Object.entries(plain);
+  for (let i = 0; i < entries.length; i++) {
+    const entry: [string, ESObject] = entries[i];
+    const key = entry[0];
+    const value: ESObject = entry[1];
+    const elementIndex = decoder.decodeElementIndex(this.serialDescriptor, key, value);
+
+    switch (elementIndex) {
+      {{#each properties}}
+      case {{@index}}:
+        {{analysis.name}}Seen = true;
+        {{#if (and (eqPrimitiveType analysis.type.kind) (not (hasDecoratorWith analysis.decorators)))}}
+        {{analysis.name}}Value = decoder.{{serializer.decodeMethod}}(value);
+        {{else}}
+        {{analysis.name}}Value = this.{{analysis.name}}Serializer.deserialize(decoder, value){{#if serializer.needsTypeAssertion}} as {{analysis.type.sourceText}}{{/if}};
+        {{/if}}
+        break;
+      {{/each}}
+      case DecodedElementIndex.UNKNOWN_NAME:
+        TurboTransLogger.error(`Encounter unknown property \`${key}\` when deserialize \`{{class.className}}\`.`)
+        throw new SerializationError(
+          SerializationErrorCodes.ENCOUNTER_UNKNOWN_KEY,
+          `Encounter unknown property \`${key}\` when deserialize \`{{class.className}}\`.`
+        );
+      case DecodedElementIndex.IGNORED_NAME:
+        continue;
+    }
+  }
+
+  {{! 必填属性验证 }}
+  const missingProperties: string[] = [];
+  {{#each properties}}
+    {{#if analysis.isMust}}
+      if (!{{analysis.name}}Seen) {
+        missingProperties.push('{{formatPropertyName analysis}}');
+      }
+    {{/if}}
+  {{/each}}
+
+  if (missingProperties.length > 0) {
+    TurboTransLogger.error(`Missing required properties [${missingProperties.map(item => `\`${item}\``).join(', ')}] when deserialize \`{{class.className}}\`.`)
+    throw new SerializationError(
+      SerializationErrorCodes.MISSING_REQUIRED_PROPERTY,
+      `Missing required properties [${missingProperties.map(item => `\`${item}\``).join(', ')}] when deserialize \`{{class.className}}\`.`
+    );
+  }
+
+  {{#if (isClassType class)}}
+    {{! 解码构造函数属性（直接反序列化）}}
+    {{! 构造函数参数（形参名和属性名一致）}}
+    const result = new {{class.className}}{{#if class.generics.isGeneric}}<{{genericParametersString class.generics.parameters}}>{{/if}}(
+      {{#each (getCtorProperties class.constructorParams properties)}}
+      {{#unless analysis.decorators.isTransient}}
+      {{analysis.name}}Value!{{#if serializer.needsTypeAssertion}} as {{analysis.type.sourceText}}{{/if}},
+      {{/unless}}
+      {{/each}});
+  {{else}}
+    const result: ESObject = {};
+  {{/if}}
+
+  {{! 可选属性赋值（构造函数外的属性）}}
+  {{#each (postConstructorAssignments class.constructorParams properties)}}
+  {{#unless analysis.decorators.isTransient}}
+  if ({{analysis.name}}Seen) {
+    result.{{analysis.name}} = {{analysis.name}}Value!{{#if serializer.needsTypeAssertion}} as {{analysis.type.sourceText}}{{/if}};
+  }
+  {{/unless}}
+  {{/each}}
+
+  return result as {{class.className}}{{#if class.generics.isGeneric}}<{{genericParametersString class.generics.parameters}}>{{/if}};
+}

package/template/SerializerTemplate.hbs

@@ -0,0 +1,176 @@
+{{! ===================================================== }}
+{{! 序列化器模板 (CoarseSerializer)                    }}
+{{! 特点：性能优先，直接对象访问，简化默认值处理                  }}
+{{! ===================================================== }}
+
+{{! 序列化名称常量 }}
+const {{class.className}}_SERIAL_NAME = '{{serialNameConstant}}';
+
+{{#if class.generics.isGeneric}}
+{{! 泛型类：工厂模式 }}
+export class {{class.className}}Serializer<{{genericParametersString class.generics.parameters}}> extends Serializer<{{class.className}}<{{genericParametersString class.generics.parameters}}>> {
+  readonly serialName: string = {{class.className}}_SERIAL_NAME;
+
+  {{! 属性序列化器声明 }}
+  {{#each properties}}
+    {{#unless (eqPrimitiveType analysis.type.kind)}}
+    private readonly {{analysis.name}}Serializer: {{serializer.typeDeclaration}};
+    {{/unless}}
+  {{/each}}
+
+  readonly serialDescriptor: SerialDescriptor;
+
+  constructor(
+    {{#each class.generics.parameters}}
+    {{toLowerCase this}}Serializer: Serializer<{{this}}>{{#unless @last}},{{/unless}}
+    {{/each}}
+  ) {
+    super();
+    {{! 初始化属性序列化器 }}
+    {{#each properties}}
+      {{#unless (eqPrimitiveType analysis.type.kind)}}
+      this.{{analysis.name}}Serializer = {{serializer.instantiationTemplate}};
+      {{/unless}}
+    {{/each}}
+
+    this.serialDescriptor = buildClassSerialDescriptor(
+      {{class.className}}_SERIAL_NAME,
+      builder => {
+        {{#each properties}}
+          {{! 处理数字属性名的特殊情况 }}
+          {{#if (isNumericPropertyName (formatPropertyName analysis))}}
+          builder.element({
+            elementName: '{{formatPropertyName analysis}}',
+            elementDecodingName: this.fixNonNegativeIntegerElementName('{{formatPropertyName analysis}}'),
+            descriptor:
+              {{#if (eqPrimitiveType analysis.type.kind)}}
+                {{serializer.name}}.INSTANCE.serialDescriptor
+              {{else}}
+                this.{{analysis.name}}Serializer.serialDescriptor
+              {{/if}}
+          });
+          {{else}}
+          builder.element({
+            elementName: '{{formatPropertyName analysis}}',
+            descriptor:
+              {{#if (eqPrimitiveType analysis.type.kind)}}
+                {{serializer.name}}.INSTANCE.serialDescriptor
+              {{else}}
+                this.{{analysis.name}}Serializer.serialDescriptor
+              {{/if}}
+          });
+          {{/if}}
+        {{/each}}
+      });
+  }
+{{else}}
+{{! 非泛型类：单例模式 }}
+export class {{class.className}}Serializer extends Serializer<{{class.className}}> {
+  private static _INSTANCE?: {{class.className}}Serializer;
+  readonly serialName: string = {{class.className}}_SERIAL_NAME;
+
+  static get INSTANCE(): {{class.className}}Serializer {
+    if (!{{class.className}}Serializer._INSTANCE) {
+      {{class.className}}Serializer._INSTANCE = new {{class.className}}Serializer();
+    }
+    return {{class.className}}Serializer._INSTANCE;
+  }
+
+  {{! 属性序列化器声明 }}
+  {{#each properties}}
+    private readonly {{analysis.name}}Serializer: {{serializer.typeDeclaration}} = {{serializer.instantiationTemplate}};
+  {{/each}}
+
+  {{! 序列描述符构建 }}
+  readonly serialDescriptor: SerialDescriptor = buildClassSerialDescriptor(
+      {{class.className}}_SERIAL_NAME,
+      builder => {
+        {{#each properties}}
+          {{! 处理数字属性名的特殊情况 }}
+          {{#if (isNumericPropertyName (formatPropertyName analysis))}}
+          builder.element({
+            elementName: '{{formatPropertyName analysis}}',
+            elementDecodingName: this.fixNonNegativeIntegerElementName('{{formatPropertyName analysis}}'),
+            descriptor: this.{{analysis.name}}Serializer.serialDescriptor
+          });
+          {{else}}
+          builder.element({
+            elementName: '{{formatPropertyName analysis}}',
+            descriptor: this.{{analysis.name}}Serializer.serialDescriptor
+          });
+          {{/if}}
+        {{/each}}
+      }
+    )
+
+  private constructor() {
+    super();
+  }
+{{/if}}
+
+  {{! 序列化方法：返回ESObject }}
+  serialize(encoder: Encoder, value: {{#if class.generics.isGeneric}}{{class.className}}<{{genericParametersString class.generics.parameters}}>{{else}}{{class.className}}{{/if}}): ESObject {
+    {{#if (canReturnDirectly class)}}
+    {{! 性能优化：只包含基础类型时直接返回对象 }}
+      if (encoder.allowSourceReuse()) {
+        return value;
+      }
+      return this.innerSerialize(encoder, value);
+    {{else}}
+      return this.innerSerialize(encoder, value);
+    {{/if}}
+  }
+
+  private innerSerialize(encoder: Encoder, value: {{#if class.generics.isGeneric}}{{class.className}}<{{genericParametersString class.generics.parameters}}>{{else}}{{class.className}}{{/if}}): ESObject { 
+    const keys = this.serialDescriptor.elementNames;
+    const result = encoder.newObject();
+    {{#each properties}}
+      {{! 根据类型选择编码方法 }}
+      {{#if (and (eqPrimitiveType analysis.type.kind) (not (hasDecoratorWith analysis.decorators)))}}
+      encoder.{{serializer.encodeMethod}}(result, keys[{{@index}}], value.{{analysis.name}});
+      {{else}}
+      encoder.encodeSerializableElement(result, keys[{{@index}}], this.{{analysis.name}}Serializer, value.{{analysis.name}});
+      {{/if}}
+    {{/each}}
+
+    return result;
+  }
+  
+  {{! 动态包含反序列化模板 - 使用从上下文传递的deserializeTemplate参数 }}
+  {{> (lookup . "deserializeTemplate")}}
+}
+{{#if class.generics.isGeneric}}
+{{! 基于 BaseSerializerFactory 的工厂类 }}
+export class {{class.className}}SerializerFactory extends BaseSerializerFactory<{{class.className}}<{{genericParametersESObjString class.generics.parameters}}>> {
+
+  protected getSerialName(): string {
+    return {{class.className}}_SERIAL_NAME;
+  }
+
+  protected getRequiredSerializersCount(): number {
+    return {{class.generics.parameters.length}};
+  }
+
+  protected newSerializer(genericArgumentsSerializers: Serializer<ESObject>[]): Serializer<{{class.className}}<{{genericParametersESObjString class.generics.parameters}}>> {
+    return new {{class.className}}Serializer<{{genericParametersESObjString class.generics.parameters}}>(
+      {{#each class.generics.parameters}}
+      genericArgumentsSerializers[{{@index}}]{{#unless @last}},{{/unless}}
+      {{/each}}
+    );
+  }
+
+  protected getSerializerName(): string {
+    return {{class.className}}Serializer.name;
+  }
+}
+{{/if}}
+
+{{#if (isClassType class)}}
+{{#if class.generics.isGeneric}}
+{{! 工厂注册 }}
+registerAutoGeneratedSerializerEntryProviderForSupplementary({{class.className}}_SERIAL_NAME, () => [{{class.className}}, new {{class.className}}SerializerFactory()]);
+{{else}}
+{{! 单例注册 }}
+registerAutoGeneratedSerializerEntryProviderForSupplementary({{class.className}}_SERIAL_NAME, () => [{{class.className}}, {{class.className}}Serializer.INSTANCE]);
+{{/if}}
+{{/if}}

package/tsconfig.json

@@ -0,0 +1,17 @@
+{
+  "compilerOptions": {
+    "target": "ES2021",
+    "module": "commonjs",
+    "strict": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true,
+    "sourceMap": false,
+    "removeComments": true,
+    "outDir": "./dist",
+    "rootDir": "./src",
+    "declaration": true
+  },
+  "include": ["./src/**/*"],
+  "exclude": ["./node_modules/", "./dist/", "./tests/"]
+}

package/tslint.json

@@ -0,0 +1,3 @@
+{
+  "extends": "tslint:recommended"
+}