README

PHP QA git 钩子

PHP 提交质量保证的 Git 钩子

需求

• git
• bash
• PHP CLI
• 核心工具

特性

• 通过 git 配置选项进行自定义
• 在提交前检查 PHP 语法
• 在提交前检查 Git 冲突标记
• 警告关于 PHP 导出函数 (var_dump(), var_export(), print_r())
• 在推送前检查 PHP 代码风格
• 在推送前运行 PHPUnit 测试
• 彩色输出

通过 Composer 安装

1. 安装包

    composer require --dev nafigator/php-qa-hooks
   

2. 将 extra 部分添加到 composer.json

    "extra": {
        "scripts-dev": {
            "post-install-cmd": "vendor/nafigator/php-qa-hooks/src/hooks-install.sh"
        }
    }
   

3. 将 phpcs.xml 放置在项目的根目录。

   注意：可以在 PHP_CodeSniffer 存储库中找到 phpcs.xml 文件的示例：[phpcs.xml.dist](https://raw.githubusercontent.com/squizlabs/PHP_CodeSniffer/3.4.2/phpcs.xml.dist)

4. 运行 composer install。

卸载

1. 移除 git 配置部分 check.php

    git config --remove-section check.php
   

2. 将 extra 部分添加到 composer.json

    "extra": {
        "scripts-dev": {
            "post-install-cmd": "vendor/nafigator/php-qa-hooks/src/hooks-uninstall.sh"
        }
    }
   

   提交您的更改并推送至仓库。当卸载脚本完成所有工作副本的清理后，继续下一步。

3. 移除包

    composer remove --dev nafigator/php-qa-hooks
   

4. 从项目的根目录中移除 phpcs.xml

配置

示例（关闭颜色）

git config check.php.colors false

可用的 git 配置选项

check.php.colors [true|false]
check.php.conflicts [true|false]
check.php.dumps [true|false]
check.php.phpunit [true|false]
check.php.style [true|false]
check.php.syntax [true|false]

注意：PHPUnit 默认禁用。您需要手动启用它。

版本控制

此软件遵循 "语义版本控制" 规范。所有声明的公共 API 函数签名。

更多关于 SemVer.org。