README

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

要求

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

安装

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

# Download using curl
curl -OL https://squizlabs.github.io/PHP_CodeSniffer/phpcs.phar
curl -OL https://squizlabs.github.io/PHP_CodeSniffer/phpcbf.phar

# Or download using wget
wget https://squizlabs.github.io/PHP_CodeSniffer/phpcs.phar
wget https://squizlabs.github.io/PHP_CodeSniffer/phpcbf.phar

# Then test the downloaded PHARs
php phpcs.phar -h
php phpcbf.phar -h

Composer

如果您使用 Composer，可以使用以下命令全局安装 PHP_CodeSniffer

composer global require "squizlabs/php_codesniffer=*"

确保您的 PATH 中包含 composer bin 目录。默认值为 ~/.composer/vendor/bin/，但您可以通过运行 composer global config bin-dir --absolute 检查所需值。

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

{
    "require-dev": {
        "squizlabs/php_codesniffer": "3.*"
    }
}

然后您将能够从 vendor bin 目录中运行 PHP_CodeSniffer

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

Phive

如果您使用 Phive，可以使用以下命令将 PHP_CodeSniffer 作为项目工具安装

phive install phpcs
phive install phpcbf

然后您将能够从工具目录中运行 PHP_CodeSniffer

./tools/phpcs -h
./tools/phpcbf -h

PEAR

如果您使用 PEAR，可以使用 PEAR 安装程序安装 PHP_CodeSniffer。这将使 phpcs 和 phpcbf 命令立即可用。要使用 PEAR 安装程序安装 PHP_CodeSniffer，首先确保您已经 安装了 PEAR，然后运行以下命令

pear install PHP_CodeSniffer

Git Clone

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

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

文档

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

问题

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

贡献

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