PHP_CodeSniffer 技术文档

1. 安装指南

下载安装

最简单的开始使用 PHP_CodeSniffer 的方式是下载对应的 Phar 文件：

# 使用 curl 下载
curl -OL https://squizlabs.github.io/PHP_CodeSniffer/phpcs.phar
curl -OL https://squizlabs.github.io/PHP_CodeSniffer/phpcbf.phar

# 或者使用 wget 下载
wget https://squizlabs.github.io/PHP_CodeSniffer/phpcs.phar
wget https://squizlabs.github.io/PHP_CodeSniffer/phpcbf.phar

# 测试下载的 PHAR 文件
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

然后，你将能够从 tools 目录运行 PHP_CodeSniffer：

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

使用 PEAR 安装

如果你使用 PEAR，可以通过 PEAR 安装器安装 PHP_CodeSniffer。这将使得 phpcs 和 phpcbf 命令立即可用。首先确保你已经安装了 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

2. 项目使用说明

PHP_CodeSniffer 的默认编码标准是 PEAR 编码标准。要检查一个文件，只需指定文件位置：

phpcs /path/to/code/myfile.php

如果要检查整个目录，可以指定目录位置：

phpcs /path/to/code-directory

如果你想使用 PSR-12 编码标准检查代码，可以使用 --standard 命令行参数：

phpcs --standard=PSR12 /path/to/code-directory

如果 PHP_CodeSniffer 发现任何编码标准错误，运行命令后会显示报告。

完整的用法信息和示例报告可在 用法页面 上找到。

3. 项目 API 使用文档

PHP_CodeSniffer 提供了丰富的 API 用于自定义和扩展其功能。开发者可以通过编写自定义的 sniffs 来扩展 PHP_CodeSniffer 的检查能力。API 文档可以在 PHP_CodeSniffer GitHub Wiki 上找到。

4. 项目安装方式

请参考上述的“安装指南”部分，了解 PHP_CodeSniffer 的多种安装方式。根据你的项目需求和开发环境，选择最适合你的安装方式。