Roc语言格式化工具中的字符串插值处理问题分析

Roc语言编译器团队最近发现并修复了一个与字符串插值格式化相关的bug，该问题影响了基础命令行工具(basic-cli)构建脚本的格式化功能。本文将深入分析该问题的技术细节、成因以及解决方案。

问题现象

当用户尝试使用roc format命令格式化包含特定字符串插值语法的Roc代码时，编译器会报错并提示"格式化失败，格式化后的树结构不一致"。具体表现为编译器内部断言失败，认为格式化前后的抽象语法树(AST)不一致。

最小化复现案例

通过最小化工具，团队将问题复现案例简化为以下代码片段：

app []{}o!"\(e)"
i=S

这段代码经过格式化后会变成：

app [] {}o! "$(e)"
i = S

技术分析

问题的核心在于新旧字符串插值语法处理的不一致性。在格式化过程中，编译器内部存在两种字符串插值表示方式：

1. DeprecatedInterpolated - 旧式插值语法
2. Interpolated - 新式插值语法

格式化工具在处理这段代码时，会将旧式插值语法自动升级为新式语法，但却没有在格式化后的AST比较阶段考虑到这种语法升级的合法性，导致断言失败。

根本原因

该问题源于代码重构时的疏忽。在之前的提交中(6978ca7)，团队引入了字符串插值语法的自动升级功能，但存在两个潜在解决方案未被充分考虑：

1. 应该在解析器阶段就显式完成语法升级，而不是在格式化阶段
2. 如果选择在格式化阶段处理，需要确保RemoveSpaces实现能够将两种语法规范化为统一形式

由于没有正确处理这两种语法的等价性，导致格式化工具在验证AST一致性时失败。

解决方案

团队最终选择了第二种方案，修改了格式化工具的AST比较逻辑，使其能够识别新旧字符串插值语法的等价性。这样既保持了向后兼容性，又解决了格式化失败的问题。

经验总结

这个案例展示了语法演进过程中常见的兼容性问题。在编程语言开发中，当引入新的语法替代旧语法时，需要特别注意：

1. 转换阶段的统一性 - 转换应该在一个明确的阶段完成
2. 工具链的协调性 - 所有工具(解析器、格式化器、编译器)需要对新旧语法有一致的处理逻辑
3. 错误处理的完备性 - 对于预期内的语法转换，应该有明确的处理路径而非视为错误

Roc团队通过这个问题的解决，进一步完善了其格式化工具对语言语法演进的支持能力，为后续的语言特性更新积累了宝贵经验。