bernardosilva/git-hooks-installer-plugin

1.2.1 2017-12-13 12:38 UTC

README

Latest Stable Version Total Downloads Monthly Downloads License Build Status Code Coverage

此项目的目标是共享和强制执行所有项目的代码标准。

为什么创建这个?

目前有成百万的PHP项目不遵循或适应任何代码标准。

我认为主要原因有以下几点:

  • 没有时间实现一个检查它们的脚本;
  • 不确定这些将如何帮助;
  • 不确定如何强制所有团队成员执行;
  • 不了解这是什么;

使用git-hook包将使每个人都能共享他们的钩子并减少不遵循任何标准的项目的数量。

git-hook包

一个git-hook包是一个使用类型git-hook的composer包。

任何将git-hook-installer-plugin设置为依赖项并将type设置为git-hook的包都将使用此插件安装到您的项目中。

可用的git-hook包

创建您自己的git-hook包并在此处列出,与他人共享。

如何创建我的git-hook包?

您可以开始查看这个示例

创建新的git-hook包所需的事项?

新composer.json文件的示例

{
    "name": "yourname/your-package-name",
    "type": "git-hook",
    "description": "Composer git-hook package with hooks for your php projects.",
    "require": {
        "bernardosilva/git-hooks-installer-plugin": "^1.0.0"
    }
}

注意:您的composer.json必须具有特定的type才能在正确的目录中安装

"type": "git-hook"

此外,您的git钩子应具有执行权限。

可用的钩子

您可以在包中创建这些文件并具有执行权限。

查看所有可用的git钩子列表

如何安装

php composer.phar require bernardosilva/git-hooks-installer-plugin

如何测试

./vendor/bin/phpunit

如何贡献

  • 创建您自己的git hook composer包。

  • 创建一个PR来将您的包列在这个页面上。

  • 提出新问题或添加建议以改进此插件。

创建者

Bernardo Silva

许可协议

MIT © Bernardo Silva