bugatino/phpcs-git-pre-commit

使用 composer 和 git pre-commit 钩子设置 PHPCS,用于检查 PSR-2 标准代码。

安装次数: 3,820

依赖者: 1

建议者: 0

安全: 0

星标: 1

关注者: 2

分支: 36

语言:Shell

类型:脚本

v1.0.0 2018-05-30 04:40 UTC

This package is not auto-updated.

Last update: 2024-09-20 10:09:54 UTC


README

关于

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

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

安装

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

composer require "bugatino/phpcs-git-pre-commit"

或者,手动在 composer.json 文件中添加 bugatino/phpcs-git-pre-commit 依赖

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

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

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

然后使用 Git Bash 运行 composer installcomposer update。如果 pre-commit 钩子已存在,则将其安装或更新。

用法

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

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