phpple/gitwatcher

智能 Git 钩子集合。

维护者

详细信息

github.com/phpple/gitwatcher

源代码

问题

安装: 438

依赖: 0

建议: 0

安全: 0

星星: 1

关注者: 2

分支: 0

开放问题: 0

v0.4.8 2021-03-31 07:03 UTC

Requires

Requires (Dev)

MIT 5676bf50a1da6429c0575bae76dbc3b49e56e76b

  • ronnie.deng <comdeng.woop@live.com>

This package is not auto-updated.

Last update: 2024-09-25 23:19:08 UTC

README

GitWatcher 是一个 Git 钩子脚本的集合。

如果您想使用它，只需在 composer.json 文件中添加一些脚本。

composer require phpple/gitwatcher --dev
"scripts": {
    "post-autoload-dump": [
      "Phpple\\GitWatcher\\Composer::postAutoloadDump"
    ]
}

关注者

您可以在 src/Watcher 中找到监视器。

git_version

检查 git 版本是否大于自定义版本。默认最小版本是 2.2.0。

committer

检查提交者的信息是否有效。例如，提交者电子邮件的扩展名。

example

{
  "committer": {
    "email_extension": "live.com"
  }
}

如果您的本地 git config 中的 user.email 不是以 live.com 结尾，检查将会失败。

composer

检查 composer.json 的有效性。

example

{
  "composer": {}
}

如果任何存储库的 require 字段的版本不是常数，检查将会失败。

非法的 composer.json

{
  "require": {
    "fideloper/proxy": "^4.3"
  }
}

良好的 composer.json

{
  "require": {
    "fideloper/proxy": "4.3.0"
  }
}

StandardWatcher

通过 phpcs 检查代码的有效性。

example

{
  "standard": {
    "phpcs": "vendor/bin/phpcs",
    "target": "app/,src/",
    "mode": "all",
    "options": {
      "standard": "{$project.root}assets/rules/phpdefault.xml",
      "colors": true,
      "s": true
    }
  }
}
  • phpcs: phpcs 二进制文件的路径
  • target: 将由 phpcs 检查的目录
  • mode: [all|update]
    • all: 检查 target 中所有文件
    • update: 仅检查 target 中更新的文件
  • options: phpcs 的选项
    • standard: {$project.root} 指向 gitwatcher 的根目录。
    • colors: 用颜色打印文本
    • s: 打印问题的嗅探器
    • ... 请参阅 phpcs 帮助

自定义配置

如果您想自定义配置，您可以在您的站点根目录中添加一个文件（gitwatcher.json）。例如

{
  "@extend": "default",
  "standard": {
    "options": {
      "colors": false
    }
  }
}