GraphQL Code Generator 中 verbatimModuleSyntax 的类型导入问题解析

问题背景

在使用 TypeScript 开发 GraphQL 应用时，许多开发者会选择 GraphQL Code Generator 来自动生成类型定义文件。当项目中启用了 TypeScript 的 verbatimModuleSyntax: true 配置时，生成的代码可能会遇到类型导入错误。

verbatimModuleSyntax 的作用

verbatimModuleSyntax 是 TypeScript 4.5 引入的一个严格模式选项，它强制开发者明确区分类型导入和值导入。在这种模式下：

• 所有类型导入必须使用 import type 语法
• 禁止混合导入类型和值
• 提供更清晰的模块边界和更精确的依赖分析

问题现象

当启用 verbatimModuleSyntax 时，GraphQL Code Generator 默认生成的代码中，对于 TypedDocumentNode 的导入语句会报错：

import { TypedDocumentNode as DocumentNode } from '@graphql-typed-document-node/core';

错误提示为：TypedDocumentNode is a type and must be imported using a type-only import when verbatimModuleSyntax is enabled.

解决方案

方法一：配置 useTypeImports

在 GraphQL Code Generator 的配置文件中，可以通过设置 useTypeImports: true 来强制生成类型导入语句：

import type { CodegenConfig } from '@graphql-codegen/cli';

const config: CodegenConfig = {
  generates: {
    './db/__generated__/': {
      plugins: ['typescript', 'typescript-resolvers'],
      config: {
        useTypeImports: true
      }
    }
  }
};

export default config;

方法二：手动修改生成文件

虽然不推荐，但也可以手动修改生成的代码文件，添加 type 关键字：

import { type TypedDocumentNode as DocumentNode } from '@graphql-typed-document-node/core';

技术原理

GraphQL Code Generator 的核心功能是根据 GraphQL schema 自动生成 TypeScript 类型定义。当启用 verbatimModuleSyntax 时，TypeScript 编译器会对所有导入进行严格检查：

1. TypedDocumentNode 是一个纯类型定义
2. 在严格模式下，纯类型必须使用 import type 或 import { type ... } 语法
3. 默认生成的代码没有区分类型和值的导入

最佳实践

1. 始终配置 useTypeImports：即使当前没有启用 verbatimModuleSyntax，配置此选项可以确保代码在未来兼容性

2. 统一项目配置：如果团队决定使用 verbatimModuleSyntax，应在所有相关工具链中保持一致

3. 定期更新工具链：GraphQL Code Generator 及其插件会不断改进对 TypeScript 新特性的支持

总结

TypeScript 的 verbatimModuleSyntax 选项提供了更严格的模块导入检查，有助于提高代码质量。通过合理配置 GraphQL Code Generator 的 useTypeImports 选项，开发者可以无缝地在严格类型检查环境下使用自动生成的代码。这一小配置的调整，能够带来更好的类型安全性和代码可维护性。