Clangd项目中改进错误信息显示文件路径的实践

背景介绍

在软件开发过程中，编译器或语言服务器的错误信息对于开发者诊断问题至关重要。Clangd作为LLVM项目中的C++语言服务器，其错误信息的准确性和完整性直接影响开发者的调试效率。近期，Clangd项目中发现了一个关于错误信息显示不够完善的问题，特别是在处理文件路径相关的错误时。

问题发现

在Clangd的输出日志中，开发者注意到如下错误信息：

E[09:32:30.218] IncludeCleaner: Failed to get an entry for resolved path : No such file or directory

这条错误信息虽然指出了"没有这样的文件或目录"的问题，但没有显示具体的文件路径，这使得开发者难以快速定位问题所在。特别是在处理包含文件清理(IncludeCleaner)功能时，这种不完整的错误信息会给调试带来不便。

解决方案

经过社区讨论，开发者们提出了改进方案。原代码中处理文件入口失败的逻辑如下：

if (!FE) {
  elog("IncludeCleaner: Failed to get an entry for resolved path {0}: {1}",
       Inc.Resolved, FE.takeError());
  continue;
}

改进后的版本增加了对原始包含路径(Inc.Written)的显示：

if (!FE) {
  elog("IncludeCleaner: Failed to get an entry for resolved path {0} from "
       "include {1} : {2}",
       Inc.Resolved, Inc.Written, FE.takeError());
  continue;
}

改进效果

修改后，错误信息变得更加详细和有用。现在会显示以下信息：

1. 解析后的路径(Inc.Resolved)
2. 原始包含路径(Inc.Written)
3. 具体的错误原因

示例输出变为：

E[01:04:18.522] IncludeCleaner: Failed to get an entry for resolved path  from include <doesntexist> : No such file or directory
E[01:04:18.522] IncludeCleaner: Failed to get an entry for resolved path  from include "doesntexist.hpp" : No such file or directory
E[01:04:18.522] IncludeCleaner: Failed to get an entry for resolved path  from include "/path/doesnt/exist" : No such file or directory

技术细节

在实现过程中，开发者还注意到当Inc.Resolved为空时，输出中会出现多余的空格。经过讨论，社区决定保留这种显示方式，因为：

1. 添加引号('')虽然可以更明确地表示空路径，但会增加复杂性
2. 当前格式已经能够清楚地表达错误信息
3. 保持简单性比完美的格式更重要

总结

这个改进虽然看似简单，但对于提升开发者体验有着重要意义。它体现了良好错误信息设计的原则：

1. 提供足够的上下文信息
2. 明确指出问题所在
3. 保持简洁明了

在编译器或语言服务器的开发中，类似的错误信息改进能够显著减少开发者的调试时间，提高整体开发效率。这也提醒我们，在编写错误处理代码时，应该始终考虑最终用户(开发者)的调试需求。