Knip项目中解决.graphql文件与.d.ts文件共存时的未使用检测问题

在JavaScript和TypeScript项目中，静态代码分析工具Knip能够帮助开发者检测未被引用的文件。然而，当项目中同时存在.graphql文件和对应的.d.ts类型声明文件时，Knip会出现误报问题，错误地将所有GraphQL文件标记为未使用。

问题背景

GraphQL在现代前端开发中被广泛使用，开发者通常会为.graphql文件生成对应的.d.ts类型声明文件以提高类型安全性。这种模式会导致文件结构如下：

src/ExampleQuery.graphql
src/ExampleQuery.graphql.d.ts

在Knip的原始实现中，当检测到这样的文件结构时，工具会错误地仅将.d.ts文件标记为已使用，而将.graphql文件错误地报告为未使用。这种行为与Knip处理.js和.d.ts文件的逻辑不一致，后者能够正确识别两种文件的关联关系。

技术分析

问题的根源在于Knip的模块解析机制。原始实现中，Knip对于非JavaScript/TypeScript文件的处理逻辑较为简单，没有考虑到这些文件可能存在的类型声明文件关联关系。具体表现为：

1. 当仅存在.graphql文件时，Knip能够正确识别其使用情况
2. 当同时存在.graphql和.graphql.d.ts文件时，Knip仅识别.d.ts文件为已使用
3. 这种不一致行为导致GraphQL查询被错误标记为未使用

解决方案

Knip团队在v5.1.3版本中修复了这一问题，主要改进包括：

1. 重构了模块解析机制，使其能够处理多种文件类型的关联关系
2. 扩展了文件关联检测逻辑，使其不仅限于.js/.d.ts文件对
3. 增加了对.graphql/.graphql.d.ts文件对的特殊处理
4. 同时为支持React Native/Metro项目做了架构上的准备

实际应用

开发者现在可以正确配置Knip来检测未使用的.graphql文件，只需在配置中添加：

{
  "compilers": {
    "graphql": true
  }
}

这一配置将使Knip能够：

• 正确识别被引用的.graphql文件
• 正确处理与.d.ts文件的关联关系
• 准确报告真正未使用的GraphQL查询

升级建议

对于使用Knip并包含GraphQL的项目，建议：

1. 升级到v5.1.3或更高版本
2. 在配置中显式启用graphql编译器
3. 重新运行检测以获取准确的未使用文件报告
4. 检查之前可能被误报的.graphql文件

这一改进不仅解决了GraphQL文件的检测问题，也为Knip处理其他类型文件的关联关系奠定了基础，体现了工具对现代JavaScript生态系统的更好支持。