SQL Formatter 项目中关于 sqlc.embed() 宏格式化的技术分析

在 SQL 代码格式化工具 SQL Formatter 的使用过程中，开发者发现了一个与 sqlc 工具宏语法相关的格式化问题。这个问题主要出现在 SQLite 数据库环境下使用 sqlc 工具时，会影响到代码的编译过程。

问题现象

当开发者在 SQL 查询中使用 sqlc.embed() 宏时（这是 sqlc 工具提供的特殊语法），SQL Formatter 会在宏名和括号之间自动插入空格。例如：

原始代码：

sqlc.embed(transactions)

格式化后变为：

sqlc.embed (transactions)

这种格式化行为会导致 sqlc 工具无法正确识别宏语法，从而引发编译错误。因为 sqlc 要求宏调用必须采用连续的 sqlc.embed() 形式，中间不能有空格。

技术背景

sqlc 是一个流行的 SQL 转 Go 代码生成工具，它提供了一些特殊的宏语法来增强功能。其中 sqlc.embed() 宏用于自动展开查询结果中的字段，是开发中常用的功能。

SQL Formatter 作为一个通用的 SQL 代码格式化工具，默认会按照标准 SQL 函数的格式化规则来处理代码，即在函数名和括号之间添加空格。这种处理方式对于大多数 SQL 函数是正确的，但却与 sqlc 的特殊语法要求产生了冲突。

解决方案探讨

1. 版本升级：虽然最新版本的 SQL Formatter (15.x) 仍然存在这个问题，但建议开发者保持工具的最新状态，以获得最佳兼容性。

2. 替代方案：可以考虑使用专门为 SQL 设计的 prettier-plugin-sql-cst 插件，该插件对 SQLite 有更好的支持，且不会出现此类宏语法格式化问题。

3. 等待修复：这个问题已经被记录为已知问题，开发团队可能会在未来的版本中提供针对 sqlc 特殊语法的专门处理。

最佳实践建议

对于使用 sqlc 工具的开发者，在当前阶段可以：

• 在关键查询处暂时禁用格式化
• 手动修正格式化后的代码
• 考虑使用支持 sqlc 语法的专用格式化工具

这个问题凸显了在通用 SQL 格式化工具中处理各种方言和扩展语法时面临的挑战，也提醒我们在选择工具时需要考虑到特定生态系统的兼容性要求。