jv-testes/pre-commit

pre-commit 钩子

1.2.6 2015-08-26 19:37 UTC

This package is not auto-updated.

Last update: 2024-09-14 18:14:58 UTC


README

在我们的 pre-commit 钩子中检查

  • 语法检查(使用 php lint:“php -l”):我们检查每个提交的文件都有有效的 PHP 语法。
  • composer.json 和 composer.lock 文件的同步检查:我们检查这两个文件一起提交,以避免只提交 json 而不提交 lock,从而给其他开发者造成一些问题。
  • PHP CS Fixer 检查:使用 –dry-run 参数它不会修复,只是说明问题。使用 –fixers 参数您可以控制要执行的修复器。
  • PHP Code Sniffer 检查:与之前相同,但检查其他规则。
  • PHPMD:我们启用了有争议的规则。
  • 单元测试检查:我们现在运行大约 3,000 个测试。

PHPCsFix

PHPLint

PHPUnit

安装

安装此库的推荐方式是通过 Composer

jv-testes/pre-commit 添加为 composer 依赖项。

composer.json

"require-dev": {
    ...
    "jv-testes/pre-commit": ">=1.2.3"
}

使用方法

当开发者克隆项目时,只需要

编辑 composer.json 并添加

    "scripts": {
        "pre-update-cmd": "PreCommit\\Composer\\Script\\Hooks::preHooks",
        "pre-install-cmd": "PreCommit\\Composer\\Script\\Hooks::preHooks",
        "post-update-cmd": "PreCommit\\Composer\\Script\\Hooks::postHooks",
        "post-install-cmd": "PreCommit\\Composer\\Script\\Hooks::postHooks"
    }

记得设置钩子

自定义配置

将档案 vendor/jv-testes/pre-commit/config/* 复制到 [项目]

参考

用 PHP 编写您的 git 钩子,并将它们放在 git 控制下

PHP_CodeSniffer

PHP-CS-FIX

PHPMD

自定义 PHPCS 和 PHPMD