PHPCS的Git Pre-Commit钩子在Windows for Laravel中给了我错误

如何解决PHPCS的Git Pre-Commit钩子在Windows for Laravel中给了我错误

我已经从 composer.json 安装了 PHPCS

"require-dev": {
    "phpstan/phpstan": "^0.12.93","squizlabs/php_codesniffer": "^3.6"
},

我使用的是 laravel 8，所以我在 .git/hooks/pre-commit 文件中为预提交文件添加了以下代码：

#!/bin/sh

# get bash colors and styles here: 
# http://misc.flogisoft.com/bash/tip_colors_and_formatting
C_RESET='\e[0m'
C_RED='\e[31m'
C_GREEN='\e[32m'
C_YELLOW='\e[33m'

function __run() #(step,name,cmd)
{
    local color output exitcode

    printf "${C_YELLOW}[%s]${C_RESET} %-20s" "$1" "$2"
    output=$(eval "$3" 2>&1)
    exitcode=$?

    if [[ 0 == $exitcode || 130 == $exitcode ]]; then
        echo -e "${C_GREEN}OK!${C_RESET}"
    else
        echo -e "${C_RED}NOK!${C_RESET}\n\n$output"
        exit 1
    fi
}

modified="git diff --diff-filter=M --name-only --cached  | grep \".php$\""
ignore="resources/lang,resources/views,bootstrap/helpers,database/migrations,bin"
phpcs="./vendor/bin/phpcs ./app --report=code --colors --report-width=80 --standard=PSR2 --ignore=${ignore}"

__run "1/3" "php lint" "${modified} | xargs -r php -l"
__run "2/3" "code sniffer" "${modified} | xargs -r ${phpcs}"
__run "3/3" "phpstan" "${modified} | xargs -r vendor/bin/phpstan analyse"

但这给了我以下错误：

[2/3] code sniffer        NOK!

xargs: ./vendor/bin/phpcs: No such file or directory

编辑：

需要添加以下代码

PROJECT=`php -r "echo dirname(dirname(dirname(realpath('$0'))));"`
STAGED_FILES_CMD=`git diff --cached --name-only --diff-filter=ACMR HEAD | grep \\\\.php`

# Determine if a file list is passed
if [ "$#" -eq 1 ]
then
    oIFS=$IFS
    IFS='
    '
    SFILES="$1"
    IFS=$oIFS
fi
SFILES=${SFILES:-$STAGED_FILES_CMD}

echo "Checking PHP Lint..."
echo $FILES;exit 1;
for FILE in $SFILES
do
    php -l -d display_errors=0 $PROJECT/$FILE
    if [ $? != 0 ]
    then
        echo "Fix the error before commit."
        exit 1
    fi
    FILES="$FILES $PROJECT/$FILE"
done

if [ "$FILES" != "" ]
then

解决方法

这个钩子来自 How to setup Git commit hooks for PHP 的“Benjamin Delespierre”。

您在 fdemiramon gist 中有一个类似的示例，带有 comment：

假设您在 phpcs 文件夹中同时拥有 phpcbf 和 bin/。
最佳做法是使用 phpcs 专用包：squizlabs/PHP_CodeSniffer

这意味着：在您的 squizlabs/php_codesniffer 文件中包含 composer.json 的依赖项（您这样做了）。
例如：

{
    "require-dev": {
        "squizlabs/php_codesniffer": "3.*"
    }
}

然后您就可以从 PHP_CodeSniffer vendor 目录运行 bin：

./vendor/bin/phpcs -h
./vendor/bin/phpcbf -h

如果在 git bash shell 中使用完整路径 (/d/Xampp/htdocs/project/vendor/bin/phpcs) 不起作用，即使很困难，ls /d/Xampp/htdocs/project/vendor/bin/phpcs 确实起作用，请按照注释检查用于该文件的行尾.
您可以使用 mentioned here,git rev-parse --git-dir 获取根文件夹。

,

希望你在将 require-dev 添加到 composer 后忘记运行 composer install。

但是我已经制作了您在我的 ./.git/hooks/pre-commit 中发布的钩子并尝试提交 .php 文件。 我没有出错。

要么我在钩子脚本函数中有 pwd 并且它打印项目根目录。一切似乎都很好。

根据您的评论，我只是认为您在 Windows 上运行：

你必须这样写：

#!C:/Program\ Files/Git/usr/bin/sh.exe

而不是 unix shebang：

#!/bin/sh

---

理想路径

所需的 git 存储库初始化 & composer initialize 是您的项目基目录

假设这是您的基本目录：/d/Xampp/htdocs/proj/， 那么你生成的作曲家应该在这个目录下：

/d/Xampp/htdocs/proj/composer.json
/d/Xampp/htdocs/proj/composer.lock
/d/Xampp/htdocs/proj/vendor/

还有， 您的 .git 目录应在此目录中：

/d/Xampp/htdocs/proj/.git/

从 pwd 发布的结果来看，我认为你的 git 目录在：

/d/Xampp/htdocs/proj/api/v2/.git/

所以我建议删除 /d/Xampp/htdocs/proj/api/v2/.git/ 目录， 然后去 cd D:\\Xampp\htdocs\proj， 和git init， 它应该在 .git 下创建一个新的 D:\\Xampp\htdocs\proj 目录。

从脚本更改目录

pwd 打印当前目录，看起来钩子脚本开始运行时它的路径就是 pwd 被报告的。

您可以在行 output=...

之前添加此留置权

cd ../..
pwd

如果打印的选项卡位于其他位置而不是您的项目基目录，您可以使用 cd 更改目录。