README

这是 MediaCT 编码标准，它包含 PHPCS 和 PHPMD 的规则集。

安装

使用 composer 在主目录中安装编码标准。

composer global require mediact/coding-standard

首先配置 PHPStorm 以使用正确的 phpcs 命令。

转到 设置 > 语言 & 框架 > PHP > 代码检查器。选择 "本地" 作为路径，并填写 ~/.config/composer/vendor/bin/phpcs 的完整路径。

然后转到 设置 > 编辑器 > 检查 并搜索 PHP 代码检查器验证。选择自定义并添加 ~/.config/composer/vendor/mediact/coding-standard/src/MediaCT 的路径。

要使用标准，需要在 composer 中要求标准。

cd <project_directory>
composer require mediact/coding-standard --dev

这将把编码标准添加到项目的 vendor 目录。

要使 phpcs 使用编码标准，在项目的根目录中添加一个名为 phpcs.xml 的文件。

<?xml version="1.0"?>
<ruleset>
    <rule ref="./vendor/mediact/coding-standard/src/MediaCT"/>
</ruleset>

可以从命令行进入目录以检查标准。

cd <project_directory>
./vendor/bin/phpcs ./src

默认情况下，PHP CodeSniffer 只显示严重性高于 5 的消息。MediaCT 编码标准也有一些严重性较低的消息。这些是鼓励更好编码方式的消息，但不应该阻止拉取请求。

要配置 phpcs 以显示这些消息，执行以下命令。

~/.config/composer/vendor/bin/phpcs --config-set severity 1