README

PHP_CodeSniffer是一个PHP5脚本，可以将PHP、JavaScript和CSS文件进行标记，以检测违反的编码标准。它是一个重要的开发工具，可以确保代码保持整洁和一致。它还可以帮助防止开发人员犯的一些常见语义错误。

要求

PHP_CodeSniffer需要PHP版本5.1.2或更高版本，尽管某些sniff可能需要额外的需求，如外部应用程序和脚本。有关这些要求的信息，请参阅配置选项手册页面。

由于使用了垂直空白字符，SVN预提交钩子需要PHP版本5.2.4或更高版本。

安装PHP_CodeSniffer最简单的方法是使用PEAR安装程序。这将使phpcs命令立即可用。要使用PEAR安装程序安装PHP_CodeSniffer，请确保您已安装PEAR，然后运行以下命令

pear install PHP_CodeSniffer

如果您更喜欢使用Composer，您可以使用以下命令轻松地在系统范围内安装PHP_CodeSniffer

composer global require 'squizlabs/php_codesniffer=*'

确保您的PATH中包含~/.composer/vendor/bin/。

或者，在您的composer.json文件中包含对squizlabs/php_codesniffer的依赖项。例如

{
    "require": {
        "squizlabs/php_codesniffer": "1.*"
    }
}

然后您将能够在供应商bin目录中运行PHP_CodeSniffer

./vendor/bin/phpcs -h

您还可以下载PHP_CodeSniffer源代码，并直接从GIT签出中运行phpcs命令

git clone git://github.com/squizlabs/PHP_CodeSniffer.git
cd PHP_CodeSniffer
php scripts/phpcs -h

PHP_CodeSniffer的文档可在Github wiki上找到。

有关即将推出的功能和版本的信息可在Squiz Labs博客上找到。

如果您为PHP_CodeSniffer贡献代码，请确保它符合PEAR编码标准，并且PHP_CodeSniffer单元测试仍然通过。最容易的贡献方式是在仓库签出或自己的分支上工作，而不是安装的PEAR版本。如果您这样做，可以运行以下命令来检查是否一切准备就绪提交

cd PHP_CodeSniffer
php scripts/phpcs --ignore=*/tests/* . -n

这将给出没有输出，表示没有PEAR编码标准错误。然后

phpunit tests/AllTests.php

这将给出没有失败或错误。您可以忽略任何跳过的测试，因为这些是针对外部工具的。

可以通过PEAR错误跟踪器提交错误报告和功能请求。