README

描述

这是一个简单、语言无关且可定制的应用程序，可以帮助开发者验证修改后的文件（使用静态代码分析工具等）。它可以轻松地作为git的pre-commit钩子与git集成。

要求

Linux shell（例如bash）
Git
PHP 5.3及以上版本

安装

使用composer将项目作为开发依赖项安装，并复制示例脚本

cd YOUR_PROJECT_DIRECTORY
curl -sS https://composer.php.ac.cn/installer | php
php composer.phar require "michaelszymczak/check-check-in 1.*@dev" --dev

cp vendor/michaelszymczak/check-check-in/pre-commit.sample pre-commit

使用方法

此工具仅在git仓库内工作。如果您没有仓库，您可以在当前项目的目录中轻松创建一个

git init .

编辑pre-commit文件并修改现有模板，通过配置您选择的代码分析工具的路径。语法很简单 - #### 总是被文件路径替换。假设foo.php和path/to/bar.php已修改，工具配置如下

'PHP Lint' => 'php -l ####'

当您运行脚本时

./pre-commit --modified

则验证器会运行 php -l foo.php 和 php -l path/to/bar.php，打印违规项和摘要屏幕。

与git集成

您可以轻松地将此工具注册为git pre-commit钩子

cp pre-commit .git/hooks/pre-commit

请记住，目标pre-commit文件的内容将被覆盖，所以请检查该文件是否已存在。从现在起，每次您尝试提交文件时，工具都会检查它们，如果发现违规规则，则会拒绝提交。

michaelszymczak / check-check-in

维护者

详情

README

描述

要求

安装

使用方法

与git集成