README

此包包含一套用于 kokaha PHP 框架的编码标准测试。
原始测试由 Matthew Turland 编写，更多信息请参阅他的 github 仓库。

这些测试仅作为一个指南，可能不完全准确。如果您发现错误，请在 kokaha 问题跟踪器 上报告。

要求

这些测试是为与 PHP Codesniffer 一起使用而构建的。

安装 - Composer

将包添加到项目 composer.json 中的开发依赖项

{
    "require-dev": {
        "kohana/coding-standards": "*",
    }
}

运行 composer --dev update 以更新 composer.lock 文件并安装包。嗅探器将被安装在项目根目录中的 vendor/kohana/coding-standards，并且 phpcs 命令将被安装到 bin/phpcs。

安装 - 手动或使用 PEAR

如果您想使标准在系统范围内可用，可以将其符号链接到代码嗅探器目录，如下所示

git clone https://github.com/kohana/coding-standards.git kohana-coding-standards
cd kohana-coding-standards
sudo ln -sfn `pwd`/Kohana `pear config-get php_dir`/PHP/CodeSniffer/Standards/Kohana 
sudo ln -sfn `pwd`/test/PHP_CodeSniffer/CodeSniffer/Standards/Kohana `pear config-get test_dir`/PHP_CodeSniffer/CodeSniffer/Standards/Kohana

运行

如果您使用 composer 安装，请从您的 vendor 目录引用标准

bin/phpcs --standard=vendor/kohana/coding-standards/Kohana modules/

或者，从原始克隆中，您可以简单地引用本地副本

phpcs --standard=path/to/coding-standards/Kohana kohana/core

如果全局安装（符号链接到 PEAR），您可以如此引用标准

phpcs --standard=Kohana application/

自定义项目标准

您还可以扩展项目中使用的规则，或者包含部分而非全部的 kokaha 标准（例如，如果您正在开发一个不打算作为 kokaha 模块的项目）。您可以通过在项目根目录中添加一个 coding_standard.xml 来执行此操作，该文件指定了要包含的规则并自定义任何变量。有关详细信息，请参阅 PHP_CodeSniffer 文档。

测试

与所有代码相关的事物一样，嗅探器需要经过测试！要运行测试，它们需要在 codesniffer 目录中（即您应该运行上述命令来符号链接嗅探器/测试），并且您需要 修补 phpcs 的 AllSniffs.php。

然后只需如此运行测试

phpunit --bootstrap=`pear config-get php_dir`/PHP/CodeSniffer.php `pear config-get test_dir`/PHP_CodeSniffer/CodeSniffer/Standards/AllSniffs.php

已知问题

• 三元运算符中的表达式存在问题

请将任何新问题报告给 K3 错误跟踪器，并将其归档在 "PHPCS 编码标准" 下