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=*'

请确保 ~/.composer/vendor/bin/ 在您的 PATH 中。

或者，在您的 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 错误跟踪器 上提交错误报告和功能请求。