smgladkovskiy/phpcs-git-pre-commit

提交前进行 PHPCS 检查

维护者

详细信息

github.com/smgladkovskiy/phpcs-git-pre-commit

源代码

问题

安装次数: 21,524

依赖关系: 1

建议者: 0

安全性: 0

星标: 38

关注者: 3

分支: 36

开放问题: 0

语言:Shell

类型:脚本

dev-master 2022-04-12 06:32 UTC

Requires

MIT 5b8e5d64f75d1d290cc41d8dde80cde3f84a9a6a

  • Sergey Gladkovskiy <smgladkovskiy.woop@gmail.com>

This package is not auto-updated.

Last update: 2024-09-14 20:25:23 UTC

README

关于

自动安装 git pre-commit 钩子，用于运行 PHP Code Sniffer 代码检查以确保 PSR2 编码标准合规性。它只会检查要提交的文件。

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

安装

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

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

或者，可以手动在 composer.json 文件中添加 smgladkovskiy/phpcs-git-pre-commit 的依赖项

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

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

"scripts": {
    "install-hooks": ["sh ./vendor/smgladkovskiy/phpcs-git-pre-commit/src/setup.sh"],
    "post-install-cmd": ["@install-hooks"],
    "post-update-cmd": ["@install-hooks"]
}

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

使用方法

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

php phpcs.phar --standard=PSR2 --encoding=utf-8 -n -p /path/to/file.php

贡献

欢迎提交 pull request！