# QuickTransformer

**Repository Path**: KwaiAppTeam/quick-transformer

## Basic Information

- **Project Name**: QuickTransformer
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 14
- **Forks**: 2
- **Created**: 2025-03-27
- **Last Updated**: 2025-09-01

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# QuickTransformer

## 使用方式
- 安装 @kwai_harmony/quick-transformer 依赖
```shell
  npm install quick-transformer-codegen-plugin
  ohpm install @kwai_harmony/quick-transformer
```
- 工程根目录下 hvigor/hvigor-config.json5 中, dependencies 添加插件依赖
```json
  "dependencies": {
    "quick-transformer-codegen-plugin": "1.1.4"
  }
```
- 工程根目录下 hvigorfile.ts 中, 注册插件
```typescript
import { hvigor } from '@ohos/hvigor';
import { ClassTransformerCodeGenPlugin } from 'quick-transformer-codegen-plugin';

export default {
  system: appTasks,  /* Built-in plugin of Hvigor. It cannot be modified. */
  plugins:[
    ClassTransformerCodeGenPlugin(hvigor, {
      // whiteDirList: 源代码文件**父**路径白名单, 从工程根目录开始
      whiteDirList: ['/entry/src/main/ets/model'],
      // blackDirList: 源代码文件**父**路径黑名单, 从工程根目录开始
      blackDirList: []
      // whiteDirList 和 blackDirList 都不配置的情况, 默认对工程进行全扫描
    })
  ]
}
```
- 配套引入 @kwai_harmony/quick-transformer 依赖
```json
  "dependencies": {
    "@kwai_harmony/quick-transformer": "1.1.4"
  }
```
- 在 App 启动早期, 调用 QuickTransformer.installHook() 自动替换 class-transformer 的调用
```typescript
import { QuickTransformer } from '@kwai_harmony/quick-transformer'
  
QuickTransformer.installHook()
```