SQL Formatter 项目中的配置文件加载问题解析

在SQL代码格式化工具SQL Formatter的最新版本中，开发者发现了一个关于配置文件加载的重要问题。本文将深入分析该问题的技术背景、产生原因以及解决方案。

问题现象

当用户在当前目录下放置.sql-formatter.json配置文件时，CLI工具无法自动识别该文件，除非显式使用--config参数指定。这导致了一些特定SQL方言（如PostgreSQL）的格式化功能无法正常工作。

技术背景

SQL Formatter是一个流行的SQL代码格式化工具，支持多种SQL方言。它允许用户通过配置文件来自定义格式化行为，包括指定SQL方言、缩进风格等参数。默认情况下，工具应该能够自动发现当前工作目录下的配置文件。

问题根源

经过代码分析，发现问题出在配置文件搜索逻辑上。工具默认从安装目录而非当前工作目录搜索配置文件，这与大多数现代命令行工具的预期行为不符。这种设计导致了用户本地的配置文件被忽略。

影响范围

这个问题主要影响：

1. 使用PostgreSQL特有语法（如类型转换操作符::）的用户
2. 依赖本地配置文件自定义格式化规则的用户
3. 在CI/CD流程中依赖自动配置文件发现的场景

解决方案

项目维护者迅速响应，在15.4.4版本中修复了这个问题。修复后的版本能够正确地从当前工作目录加载配置文件，无需额外指定--config参数。

最佳实践

对于SQL Formatter用户，建议：

1. 升级到15.4.4或更高版本
2. 将配置文件放在项目根目录
3. 对于关键项目，仍可考虑显式指定配置文件路径以确保一致性

总结

这个问题的修复提升了SQL Formatter的易用性和预期一致性，使其更符合开发者对命令行工具的常规预期。对于依赖SQL格式化的开发团队，及时升级可以避免不必要的配置困扰。