devchainsrl/phpcs-phpcbf-git-pre-commit

提交前PHPCS检查

维护者

详细信息

github.com/devchainsrl/phpcs-phpcbf-git-pre-commit

来源

安装: 6

依赖者: 1

建议者: 0

安全性: 0

星标: 0

关注者: 1

分支: 36

语言:Shell

类型:脚本

dev-master 2021-04-20 07:52 UTC

Requires

MIT db570ff169120270d17592e4792df3c0960072d5

  • Sergey Gladkovskiy <smgladkovskiy.woop@gmail.com>
  • Suciu Remus Gabriel <gabi.woop@devchain.ro>

This package is auto-updated.

Last update: 2024-09-20 15:24:30 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": {
        "devchainsrl/phpcs-phpcbf-git-pre-commit": "dev-master"
    }
}

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

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

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

用法

运行git commit，预提交钩子将检查您提交的文件，就像您运行了以下命令一样

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

贡献

欢迎提交pull请求！