如何配置Clangd将非标准扩展名文件识别为头文件处理

问题说明 #

维护老旧C代码库时，部分头文件使用.s、.e等非标准扩展名，因兼容性要求无法重命名。clangd默认将这类文件识别为独立C源文件处理，触发如下报错：

Unable to handle compilation, expected exactly one compiler job in ''clang(fe_expected_compiler_job)

可通过clangd配置强制指定这类文件按头文件规则处理，无需修改原文件名。

配置方案 #

推荐优先使用项目级配置，配置可随代码库同步，所有协作者拉取代码后自动生效。

1. 项目级配置（推荐） #

在项目根目录新建名为.clangd的配置文件，写入以下内容：

---
# 匹配所有.s、.e后缀的文件，可按需追加其他后缀规则
If:
  PathMatch:
    - '.*\.s$'
    - '.*\.e$'
CompileFlags:
  # 强制将匹配到的文件识别为C头文件，不作为独立编译单元
  Add: [-x, c-header]
---

2. 全局用户配置 #

如果不希望修改项目内文件，可修改clangd用户级全局配置，配置文件路径按操作系统区分：

• Linux/macOS：~/.config/clangd/config.yaml
• Windows：%APPDATA%\clangd\config.yaml
  在配置文件中追加和上述项目级配置完全相同的规则段即可，规则对本地所有项目生效。

注意事项 #

• 如果非标准后缀的头文件属于C++项目，将配置中c-header替换为c++-header即可
• 如果项目中同时存在标准汇编.s源文件，需调整PathMatch的正则规则，比如限定匹配特定目录下的.s文件，避免将汇编源文件误识别为头文件
• 配置保存后，重启clangd语言服务即可生效（VSCode等编辑器可通过命令面板执行Clangd重启命令），不需要修改任何原有代码文件，完全满足老旧库兼容性要求。

内容的提问来源于stack exchange，提问作者Gabriel Devillers