jover_be/drupal-pre-commit

此包已被弃用且不再维护。作者建议使用jover_be/drupal-code-check包。

Git 预提交钩子,用于检查 Drupal 编码标准等。

v0.0.13 2017-04-18 14:59 UTC

This package is not auto-updated.

Last update: 2022-02-01 13:03:17 UTC


README

Git 预提交钩子,用于检查 Drupal 编码标准等。

Latest Stable Version Total Downloads Latest Unstable Version License composer.lock

描述

此 Git 预提交钩子将在您的基于 Composer 的 Drupal 项目上生效。

预提交钩子将检查的内容

  • 使用 PHP Linter 进行语法检查
  • 自动尝试通过 PHP Code Sniffer Beautifier and Fixer 匹配代码风格
  • 使用 PHP Code Sniffer 进行编码标准检查
  • 黑名单字符串检查/验证

请注意,以下来源的文件将 不会检查

  • Drupal 核心库
  • 贡献模块
  • 贡献库
  • 贡献主题
  • 贡献配置文件

入门

先决条件

  • Composer
  • 基于 Composer 的 Drupal 项目
  • PHP 5.4 或更高版本

安装

将此项目添加到您的基于 Composer 的 Drupal 项目的 composer.json 文件中作为依赖项。

composer require jover_be/drupal-code-check

别忘了更新...

composer update jover_be/drupal-code-check

为了激活 Git 钩子,更新您的 composer.json 文件,如下所示

{
    "scripts": {
        "post-install-cmd": [
            "jover_be\\drupal_code_check\\GitHooks::create"
        ],
        "post-update-cmd": [
        	"jover_be\\drupal_code_check\\GitHooks::create",
        ]
    }
}

开发要求

如果您想将其作为开发需求(require-dev)安装,请使用项目 neronmoon/scriptsdev 来执行脚本,前提是您的项目安装在开发模式下。

composer require --dev neronmoon/scriptsdev
composer require --dev jover_be/drupal-code-check

相反,您应该使用如下描述的 scripts-dev 部分

{
    "extra": {
        "scripts-dev": {
            "post-install-cmd": [
                "jover_be\\drupal_code_check\\GitHooks::create"
            ],
            "post-update-cmd": [
                "jover_be\\drupal_code_check\\GitHooks::create",
            ]
        }
    }
}

作者

jover.be

许可

本项目采用 MIT 许可证 - 请参阅 LICENSE 文件以获取详细信息。