README

这是一个正在进行中的作品！

PHP Hound 运行一组用于PHP的质量保证工具，并将结果汇总为一份简洁的报告。

当前支持

• PHPCodeSniffer：根据PSR-2进行代码风格和缩进。
• PHPCopyPasteDetector：检测重复代码。
• PHPMessDetector：检查复杂、未使用、损坏或不清晰的代码。

安装

PHP Hound 可以通过Composer安装。

本地安装

要本地安装，请运行以下命令

composer require alanwillms/php-hound

然后您可以通过运行./vendor/bin/php-hound来执行PHP Hound。

全局安装

您可以使用以下命令全局安装PHP Hound

composer global require alanwillms/php-hound

然后您可以将~/.composer/bin目录添加到您的PATH，这样您就可以在任何地方简单地输入php-hound来运行它。如果您想这样做，请将以下内容添加到您的~/.profile（或~/.bashrc）文件中

export PATH="$HOME/.composer/vendor/bin:$PATH"

如果您想将更改应用于当前终端会话，请运行source ~/.profile（或source ~/bashrc）。

命令行使用

基本用法

# Analyze current directory files
php-hound

# Analyze "informed/directory/" files
php-hound informed/directory/

# Analyze "script.php" file
php-hound script.php

您可以运行php-hound --help来显示所有可用选项的列表。

php-hound [optional arguments] [path to be analysed]

Optional Arguments:
	-f format, --format format (default: text)
		Output format
	-h, --help
		Prints a usage statement
	-i ignore, --ignore ignore (default: vendor,tests,features,spec)
		Ignore a comma-separated list of directories
	-v, --version
		Prints installed version

逐步修复遗留代码

如果您有一大堆遗留代码，很难一次性修复所有代码问题，并且在一个提交中完成。

PHP Hound 通过仅警告分支或提交中修改的文件和行中找到的问题，帮助您逐步修复代码。所有其他文件或行将被忽略。

这很简单就能实现

# Usage:
# php-hound --git-diff <commits or branches to compare> <target directory>

# Only return issues found on lines and files changed on the "windows10" branch:
php-hound --git-diff master..windows10 /path/to/git/repo

# Only return issues found on lines and files changed between two commits
php-hound --git-diff b28a1df..4fff883 /path/to/git/repo