让TS自己写 import 和 type-only import

2023-09-10 20:44:41

使用 TypeScript 自动转换 import 和 type-only import

简介

在 TypeScript 中管理 import 语句可能是件繁琐的任务，尤其是在项目不断发展的情况下。为了解决这个问题，本文将探讨一种使用 TypeScript 装饰器元数据实现自动转换 import 和 type-only import 的方法。

装饰器元数据简介

装饰器元数据是在装饰器函数中附加到类、方法或属性上的信息，可以通过 Reflect.getMetadata() 函数检索。利用 TypeScript 的 @Decorator() 语法，我们可以定义装饰器，这些装饰器可以为被装饰的元素添加元数据。

自动转换实现

为了自动转换 import 和 type-only import，我们需要使用 TypeScript 的 TransformerFactory 和 Transformer 接口。通过定义一个 AutoImportTransformerFactory，我们可以创建一个 AutoImportTransformer，它将自动将装饰的元素的类型导入到当前模块中。

function AutoImport(module: string) {
  return function (target: any, propertyKey: string | symbol) {
    Reflect.defineMetadata('autoImport', module, target, propertyKey);
  };
}

class AutoImportTransformerFactory implements TransformerFactory {
  createTransformer(): Transformer<SourceFile> {
    return new AutoImportTransformer();
  }
}

class AutoImportTransformer implements Transformer<SourceFile> {
  transform(sourceFile: SourceFile): SourceFile {
    // ...
  }
}