ElixirLS项目中的.formatter.exs路径解析问题解析

问题背景

在Elixir生态系统中，ElixirLS作为语言服务器为开发者提供了强大的代码格式化功能。然而，在使用过程中，开发者可能会遇到一个特殊问题：当项目处于编译状态时，格式化功能会间歇性失效，并提示"File not included in .formatter.exs"的错误信息。

问题现象

该问题主要出现在以下场景：

1. 开发者使用VS Code编辑器并启用"保存时格式化"功能
2. 项目为Elixir的umbrella项目结构
3. .formatter.exs配置文件中使用了动态路径生成
4. 问题在项目编译过程中尤为明显

典型的表现是：第一次保存文件时格式化正常，但在项目编译过程中再次保存时出现错误提示，编译完成后格式化功能又恢复正常。

技术原理分析

问题的根源在于Elixir编译器在编译过程中会改变当前工作目录(CWD)，而.formatter.exs配置文件中的路径解析逻辑没有考虑到这一变化。

在示例项目中，.formatter.exs使用了如下动态路径生成方式：

apps_with_common_rules = 
  "{#{"apps/*" |> Path.wildcard() |> Enum.map(&Path.basename/1) |> List.delete("some_app") |> Enum.join(",")}}"

这种写法依赖于当前工作目录来解析"apps/*"路径。当Elixir编译器改变工作目录时，路径解析就会失败，导致ElixirLS无法正确识别文件是否应该被格式化。

解决方案

正确的做法是使用文件相对路径而非工作目录相对路径。修改后的.formatter.exs应使用__DIR__宏来获取配置文件所在目录：

apps_with_common_rules =
  "{#{"#{__DIR__}/apps/*" |> Path.wildcard() |> Enum.map(&Path.basename/1) |> List.delete("some_app") |> Enum.join(",")}}"

这种写法确保了无论当前工作目录如何变化，路径解析始终基于.formatter.exs文件所在的位置，保证了路径解析的稳定性。

最佳实践建议

1. 在.formatter.exs中使用绝对路径或基于__DIR__的相对路径
2. 避免依赖当前工作目录进行路径解析
3. 对于umbrella项目，考虑为每个子应用单独配置.formatter.exs
4. 测试格式化功能在不同场景下的表现，包括编译过程中

总结

ElixirLS作为强大的开发工具，其格式化功能依赖于正确的.formatter.exs配置。理解Elixir编译器的工作目录变化机制对于编写可靠的格式化配置至关重要。通过使用__DIR__宏确保路径解析的稳定性，开发者可以避免格式化功能在特殊场景下的失效问题，提升开发体验。