wickedreports/phpcs-pre-commit-hook

提交前进行 PHPCS 检查

维护者

详细信息

github.com/WickedReports/phpcs-pre-commit-hook

来源

问题

安装次数: 20,034

依赖者: 0

建议者: 0

安全: 0

星星: 19

关注者: 1

分支: 12

开放性问题: 0

语言:PowerShell

类型:脚本

0.8 2021-02-25 11:37 UTC

Requires

GPL-3.0 cec28e968d6321c3a5689a3959de9755dfe67179

  • Stanislav Malkin <stan.woop@wickedreports.com>

This package is not auto-updated.

Last update: 2024-09-20 04:08:04 UTC

README

关于

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

受以下启发：使用 composer、git 钩子和 phpcs 强制执行代码标准 和 https://github.com/smgladkovskiy/phpcs-git-pre-commit 以及 https://gist.github.com/BrizzleRocker/62ed61b37acf05344d4bce894e719251。安装程序检查托管机上的操作系统并安装平台所需的钩子。

安装

使用 composer require 命令安装 wickedreports/phpcs-pre-commit-hook

composer require "wickedreports/phpcs-pre-commit-hook"

或者，您可以手动在 composer.json 文件中包含 wickedreports/phpcs-pre-commit-hook 的依赖项

{
    "require-dev": {
        "wickedreports/phpcs-pre-commit-hook": "*"
    }
}

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

"scripts": {
    "post-install-cmd": [
        "PHPCodeChecker\\Installer::postInstall"
    ],
    "post-update-cmd": [
        "PHPCodeChecker\\Installer::postInstall"
    ]
}

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

用法

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

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