unh3ck3d / php-cs-fixer-git-hook

使用 CaptainHook 运行 Git hook，对暂存文件执行 PHP CS Fixer 以自动修复并在提交前重新暂存

维护者

详细信息

github.com/Unh3ck3d/php-cs-fixer-git-hook

开放问题: 0

v1.0.0 2023-11-06 15:31 UTC

Requires

Requires (Dev)

Suggests

captainhook/plugin-composer: Ensures that CaptainHook hooks get installed automagically

Provides

None

Conflicts

None

Replaces

None

MIT 76755179d2d29d6795489e919c9e0e1df29daae5

php git HOOK lint php-cs-fixer captainhook captainhook-extension

dev-main
v1.0.0

This package is auto-updated.

Last update: 2024-09-06 17:31:56 UTC

README

php-cs-fixer-git-hook

使用 CaptainHook 运行 Git hook，对暂存文件执行 PHP CS Fixer 以自动修复并在提交前重新暂存
报告错误 · 请求功能

关于项目

Git hook，每次执行 git commit 命令时，都会在暂存文件上运行 Php Cs Fixer 以自动修复并在提交前重新暂存。

要求

PHP >= 8.0
CaptainHook >= 5.0
PHP CS Fixer

安装

使用 composer 将软件包安装为开发依赖项

composer require --dev unh3ck3d/php-cs-fixer-git-hook

将以下代码添加到您的 captainhook.json 配置文件中

{
  "pre-commit": {
    "enabled": true,
    "actions": [
      {
        "action": "\\Unh3ck3d\\PhpCsFixerGitHook\\LintStagedFiles"
      }
    ]
  }
}

按照 CaptainHook 文档安装新添加的钩子

这就完成了。从现在开始，在运行 git commit 后，暂存的文件将自动由 Php Cs Fixer 修复。

配置

您可以通过更改以下选项来自定义 Git hook 的运行行为

例如。

{
  "pre-commit": {
    "enabled": true,
    "actions": [
      {
        "action": "\\Unh3ck3d\\PhpCsFixerGitHook\\LintStagedFiles",
        "options": {
            "phpCsFixerPath": "php-cs-fixer.phar",
            "pathMode": "overwrite",
            "config": ".php-cs-fixer.php",
            "additionalArgs": "-v --dry-run --diff"
        }
      }
    ]
  }
}

许可证

在 MIT 许可证下分发。有关更多信息，请参阅 LICENSE 文件。