README

关于

自动安装的 git pre-commit 插件，用于运行 PHP Code Sniffer 进行代码检查，以确保符合 PSR12 编码标准。它只检查即将提交的文件。

灵感来源于使用 composer、git hooks 和 phpcs 强制执行代码标准

要求

您需要有一个名为 php 的 docker 服务正在运行 php-fpm，例如：yiisoftware/yii2-php:7.4-fpm。

安装

使用 composer require 命令安装 agtong/phpcs-git-pre-commit

composer require --dev "agtong/phpcs-git-pre-commit"

或者，您也可以在 composer.json 文件中手动包含 agtong/phpcs-git-pre-commit 的依赖关系

{
    "require-dev": {
        "agtong/phpcs-git-pre-commit": "dev-master"
    }
}

为了启用代码嗅探，在 composer.json 安装脚本中的 post-install-cmd 和 post-update-cmd 中添加

"post-install-cmd": [
    "sh ./vendor/agtong/phpcs-git-pre-commit/src/setup.sh"
],
"post-update-cmd": [
    "sh ./vendor/agtong/phpcs-git-pre-commit/src/setup.sh"
]

然后运行 composer install 或 composer update。如果已存在，则将安装或更新 pre-commit 插件。

用法

运行 git commit，pre-commit 插件将检查您提交的文件，就像您运行了

docker-compose exec php /app/vendor/bin/phpcs --standard=PSR12 /path/to/file.php

注意：此检查不包括 tests 目录。

贡献

欢迎提出 pull request！

agtong / phpcs-git-pre-commit

维护者

详情

README

关于

要求

安装

用法

贡献