pgFormatter配置文件的加载机制解析

pgFormatter是一款流行的PostgreSQL SQL格式化工具，它支持通过配置文件来自定义格式化行为。本文将深入分析pgFormatter的配置文件加载机制，帮助用户正确配置和使用该工具。

配置文件加载优先级

pgFormatter按照以下顺序查找并加载配置文件：

1. 当前目录下的.pg_format文件 - 工具首先检查执行命令的当前目录中是否存在.pg_format文件
2. 用户主目录下的.pg_format文件 - 如果当前目录没有找到，则检查用户主目录(~/.pg_format)
3. Windows用户配置文件目录 - 在Windows系统上，还会检查USERPROFILE环境变量指向的目录
4. XDG配置目录 - 最后检查XDG_CONFIG_HOME环境变量指定的目录中的pg_format/pg_format.conf文件

XDG配置目录的特殊说明

对于习惯使用XDG配置规范(Linux/Unix系统)的用户，需要注意：

1. 配置文件必须放置在$XDG_CONFIG_HOME/pg_format/目录下
2. 配置文件名必须为pg_format.conf(不同于其他位置的.pg_format命名)
3. XDG_CONFIG_HOME环境变量需要正确定义，通常默认为~/.config

常见问题排查

当配置文件似乎没有生效时，可以按照以下步骤排查：

1. 使用pg_format --help确认当前使用的配置文件路径
2. 检查是否有多处配置文件存在，注意优先级规则
3. 确认XDG_CONFIG_HOME环境变量是否设置正确
4. 确保配置文件有正确的读写权限

最佳实践建议

1. 对于个人使用，推荐使用主目录下的.pg_format文件，简单直接
2. 对于团队项目，可以在项目根目录放置.pg_format文件，实现项目级统一配置
3. 在多用户环境中，可以考虑使用XDG配置规范，保持用户目录整洁
4. 重要提示：配置项名称在配置文件中需要使用连字符(-)而非下划线(_)，如keyword-case=1

通过理解pgFormatter的配置加载机制，用户可以更灵活地管理SQL格式化偏好，无论是个人使用还是团队协作都能得心应手。