README

PHP_CodeSniffer 是一组两个 PHP 脚本；主要的 phpcs 脚本用于将 PHP、JavaScript 和 CSS 文件进行分词，以检测违反定义的编码标准，第二个 phpcbf 脚本用于自动纠正编码标准违反。PHP_CodeSniffer 是确保您的代码保持清洁和一致性的基本开发工具。

要求

PHP_CodeSniffer 需要 PHP 版本 5.1.2 或更高版本，尽管个别嗅探器可能需要额外的需求，例如外部应用程序和脚本。请参阅 配置选项手册页面 了解这些要求的列表。

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

安装

开始使用 PHP_CodeSniffer 最简单的方法是下载每个命令的 Phar 文件

curl -OL https://squizlabs.github.io/PHP_CodeSniffer/phpcs.phar
php phpcs.phar -h

curl -OL https://squizlabs.github.io/PHP_CodeSniffer/phpcbf.phar
php phpcbf.phar -h

如果您使用 PEAR，可以使用 PEAR 安装程序安装 PHP_CodeSniffer。这将使 phpcs 和 phpcbf 命令立即可用于使用。要使用 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-dev": {
        "squizlabs/php_codesniffer": "2.*"
    }
}

然后您将从供应商 bin 目录中运行 PHP_CodeSniffer

./vendor/bin/phpcs -h
./vendor/bin/phpcbf -h

您还可以下载 PHP_CodeSniffer 源代码，并直接从 Git 检出中运行 phpcs 和 phpcbf 命令

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

文档

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

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

问题

可以通过 Github Issue Tracker 或 PEAR bug tracker 提交错误报告和功能请求。

贡献

有关信息，请参阅 CONTRIBUTING.md。