GrumPHP 中基于路径和文件名的任务触发机制优化

在持续集成和代码质量检查工具 GrumPHP 的使用过程中，开发者经常需要根据特定文件的变化来触发相应的检查任务。本文将深入探讨如何通过路径和完整文件名来精确控制任务触发条件，解决在实际项目中遇到的相关问题。

问题背景

在 Docker 容器化环境中使用 GrumPHP 时，开发者通常会配置多个 shell 任务来执行不同的检查。例如：

grumphp:
    tasks:
        magento_composer:
            scripts:
                - ["-c", "/usr/local/bin/composer2 --working-dir=./magento validate"]
            metadata:
                task: shell

默认情况下，GrumPHP 的 shell 任务会根据 PHP 文件的变化自动触发。然而，当需要检查 composer.json 或 composer.lock 文件变更时，简单的文件扩展名匹配会导致以下问题：

1. 任何 json 或 lock 文件的变更都会触发任务，即使这些文件与当前任务无关
2. 无法区分不同目录下的同名文件（如 magento/composer.json 和 integrations/composer.json）

解决方案演进

初始方案：文件扩展名匹配

最直接的解决方案是通过 triggered_by 参数指定文件扩展名：

magento_composer:
    triggered_by: [json, lock]

这种方法的缺点是匹配范围过大，任何 json 或 lock 文件的变更都会触发任务执行。

进阶方案：完整文件名匹配

更精确的方案是支持完整文件名匹配：

magento_composer:
    triggered_by: [composer.lock, composer.json]

甚至可以支持通配符：

magento_composer:
    triggered_by: [composer.*]

终极方案：路径+文件名匹配

对于多项目结构，最佳实践是结合路径和文件名进行精确匹配：

magento_composer:
    triggered_by: ['./magento/composer.*']

技术实现原理

GrumPHP 通过引入白名单模式(whitelist_patterns)来解决这个问题。该机制允许开发者使用正则表达式精确指定哪些文件变更应该触发任务：

magento_composer:
    triggered_by: ['json', 'lock']
    whitelist_patterns:
        - "#^magento/composer.json#"
        - "#^magento/composer.lock#"

这种实现方式：

1. 首先通过 triggered_by 筛选文件类型
2. 然后通过正则表达式进一步过滤具体文件路径
3. 保持了向后兼容性
4. 提供了最大的灵活性

实际应用示例

在多项目环境中，可以为不同目录配置独立的任务：

grumphp:
    tasks:
        magento_composer:
            triggered_by: ['json', 'lock']
            whitelist_patterns:
                - "#^magento/composer.json#"
                - "#^magento/composer.lock#"
            scripts:
                - ["-c", "/usr/local/bin/composer2 --working-dir=./magento validate"]
        
        integrations_composer:
            triggered_by: ['json', 'lock']
            whitelist_patterns:
                - "#^integrations/composer.json#"
                - "#^integrations/composer.lock#"
            scripts:
                - ["-c", "/usr/local/bin/composer2 --working-dir=./integrations validate"]

最佳实践建议

1. 对于特定目录的任务，始终使用路径白名单模式
2. 优先使用完整文件名而非简单扩展名匹配
3. 复杂的匹配需求可以通过正则表达式实现
4. 为不同项目或模块配置独立的任务和触发条件
5. 合理设置任务超时时间(process_timeout)以适应不同检查的耗时

这种精细化的任务触发机制大大提升了 GrumPHP 在复杂项目结构中的实用性，使开发者能够构建更加精确和高效的代码质量检查流程。