Dprint项目中的include/exclude行为在--stdin模式下的差异分析

背景介绍

Dprint是一个现代化的代码格式化工具，它支持通过配置文件来指定需要格式化的文件范围。在配置文件中，开发者可以使用includes和excludes选项来精确控制哪些文件应该被格式化，哪些文件应该被忽略。

问题现象

在Dprint 0.45.0版本中，发现了一个关于文件包含/排除逻辑的特殊情况。当使用标准输入模式(--stdin)时，文件排除行为与直接格式化文件时的行为不一致。

具体表现为：

1. 当配置文件中设置excludes为a/b时

   • 直接运行dprint fmt a/b/c.ts会正确地报错"no files found"
   • 但通过管道输入cat a/b/c.ts | dprint fmt --stdin $(pwd)/a/b/c.ts时，却会意外地格式化文件内容

2. 只有当将excludes改为a/b/**时，两种方式才会表现一致

技术分析

这种不一致行为源于Dprint在处理标准输入模式时对排除规则的解析逻辑存在缺陷。在常规模式下，Dprint会严格匹配排除路径，但在标准输入模式下，路径匹配逻辑不够严谨。

根本原因可能是：

1. 标准输入模式下，文件路径解析没有完全应用相同的排除规则
2. 路径匹配算法在两种模式下使用了不同的通配符处理逻辑
3. 标准输入模式可能没有正确继承配置文件中的排除设置

解决方案

该问题已在Dprint 0.46.0版本中修复。修复后，无论是否使用标准输入模式，排除规则都会保持一致的行为。

对于开发者来说，这意味着：

1. 现在可以放心地在CI/CD管道中使用标准输入模式
2. 文件排除规则的行为更加可预测
3. 不再需要为了兼容标准输入模式而调整排除路径的写法

最佳实践

为了避免类似问题，建议开发者：

1. 明确指定排除路径的模式，如使用a/b/**而非简单的a/b
2. 及时更新到最新版本的Dprint
3. 在CI/CD流程中同时测试直接格式化和标准输入格式化两种方式
4. 编写测试用例验证排除规则在各种情况下的行为

总结

文件格式化工具的路径匹配逻辑一致性对于构建可靠的开发工作流至关重要。Dprint团队及时修复了这个行为差异问题，使得开发者能够更自信地在各种场景下使用这个强大的代码格式化工具。