php-composter/php-composter-regular-expression

PHP Composter 正则表达式检查。

维护者

详细信息

github.com/php-composter/php-composer-regular-expression

源代码

问题

安装: 6

依赖: 0

建议者: 0

安全: 0

星标: 1

关注者: 3

分支: 0

开放问题: 0

类型:php-composter-action

v0.1.1 2017-10-18 18:56 UTC

Requires

MIT 8f33849604a58ebf3b837f132d3797f3ef646b6e

  • Alain Schlesser <alain.schlesser.woop@gmail.com>

This package is auto-updated.

Last update: 2024-08-24 04:56:00 UTC

README

PHP Composter 正则表达式检查。

Latest Stable Version Total Downloads Latest Unstable Version License

此 Composer 包会检查您的提交信息，以确保它们与一组正则表达式规则匹配。

这是一个 PHP Composter 动作。

目录

安装

首先，您需要将此包作为开发需求添加到您的 composer.json 文件中

composer require --dev php-composter/php-composter-regular-expression

然后，您需要添加您想要检查的正则表达式。例如，以下表达式将确保提交信息的主题行以以下单词之一开始： feature、bug、documentation、style

"extra": {
  "php-composter-regular-expression": {
    "commit-message": {
      "subject": {
        "has": "^(feature|bug|documentation|style):"
      }
    }
  }
}

基本用法

在您执行 git commit 时应该可以正常工作。

Composer 扩展参考

Composer 扩展条目的格式如下

"extra": {
  "php-composter-regular-expression": {
    "<hook to check the regular expression on>": {
      "<content element to check>": {
        "<rule>": "<regular expression>"
      }
    }
  }
}

每个钩子可以包含多个内容元素进行检查，每个内容元素可以包含多个规则。

正则表达式将被特殊分隔符字符（chr(1)）包装，因此您不需要包含这些。

支持的钩子

commit-message:

在提交后检查提交信息。

支持的内容元素

对于 commit-message 钩子

subject:

提交信息的主题行，即提交信息的第一行，直到第一个 EOL 字符。

body:

提交信息的正文，即第一个 EOL 字符之后的所有内容。

支持的规则

has:

如果正则表达式匹配一个或多个匹配项，则通过检查。

has-not:

如果没有匹配项，则通过检查。

贡献

欢迎所有反馈/错误报告/拉取请求。