jover_be / drupal-code-check
一个Git预提交钩子,用于检查Drupal编码标准和更多内容。
v0.0.13
2017-04-18 14:59 UTC
Requires
- php: >=5.4
- drupal/coder: ~8.2
- symfony/console: ~2.8|~3.0
- symfony/process: ~2.8|~3.0
README
一个Git预提交钩子,用于检查Drupal编码标准和更多内容。
描述
此Git预提交钩子将在您的基于Composer的Drupal项目中生效。
预提交钩子中将被检查的内容
- 使用PHP Linter进行语法检查
- 自动尝试通过PHP Code Sniffer Beautifier and Fixer匹配代码风格
- 使用PHP Code Sniffer进行编码标准检查
- 检查/验证黑名单字符串
注意,以下来源的文件将不会进行检查
- Drupal核心
- 贡献的模块
- 贡献的库
- 贡献的主题
- 贡献的配置文件
开始使用
先决条件
- Composer
- 基于Composer的Drupal项目
- PHP 5.4或更高版本
安装
将此项目添加到您的Composer基于的Drupal项目中作为依赖项。
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",
]
}
}
}
作者
许可
本项目采用MIT许可证 - 请参阅LICENSE文件以获取详细信息。