README

一组针对 PHP CS Fixer 的自定义修复程序，特别适用于 WordPress。这是由 weDevs 的创始人兼首席技术官 Tareq Hasan 修改的 tareq1988/wp-php-cs-fixer 版本。

什么是 php-cs-fixer？

php-cs-fixer 或 PHP Coding Standards Fixer 是由 Symfony 团队的超级棒的人们创建的一个非常棒的工具。

它帮助您的 PHP 代码/仓库遵循您团队定义的特定编码标准。

WordPress 修复程序是什么？

WordPress 使用与其他世界略有不同的编码标准。它尚未遵循 PSR 标准。

此 WordPress 专用修复程序的目标是允许 WordPress 开发者根据 WordPress 编码标准标准化其代码。

可用的修复程序

括号内的空格：此修复程序确保在定义函数、if/else 块或带括号的控制结构时，在开始括号后和结束括号前存在空格。规则名称：AiArnob/space_inside_parenthesis。
类开头后的空行：PSR 标准在类开头的大括号上有一个新行，WordPress 遵循相同的行标准。这确保在开头大括号之后存在一个空行（等于两个 \n）。规则名称：AiArnob/blank_line_after_class_opening。

安装

PHP CS Fixer：可以通过运行以下命令（作为开发依赖项）安装

composer require friendsofphp/php-cs-fixer

WP PHP CS Fixer：可以通过运行以下命令安装自定义修复程序

composer require --dev aminurislamarnob/wp-php-cs-fixer

其他设置

将以下包添加到 composer.json 文件中的 "require-dev": {}

"wp-coding-standards/wpcs": "dev-master",
"phpcompatibility/php-compatibility": "*",
"phpcompatibility/phpcompatibility-wp": "*",
"dealerdirect/phpcodesniffer-composer-installer": "^0.7"

将以下配置添加到 composer.json 文件中的 "config": {}

"allow-plugins": {
    "dealerdirect/phpcodesniffer-composer-installer": true
}

最后，您需要运行 composer update 命令来安装依赖包。

使用

创建一个文件（.php-cs-fixer.php），并将其粘贴到插件目录中

<?php
// add the custom fixers
require_once __DIR__ . '/vendor/aminurislamarnob/wp-php-cs-fixer/loader.php';

$finder = PhpCsFixer\Finder::create()
    ->exclude('node_modules')
    ->exclude('vendors')
    ->in( __DIR__ )
;

$config = new PhpCsFixer\Config();
$config
    ->registerCustomFixers([
        new AiArnob\Fixer\SpaceInsideParenthesisFixer(),
        new AiArnob\Fixer\BlankLineAfterClassOpeningFixer()
    ])
    ->setRiskyAllowed(true)
    ->setUsingCache(false)
    ->setRules( AiArnob\Fixer\Fixer::rules() )
    ->setFinder( $finder )
;

return $config;

通过运行命令进行修复

配置完成后，从命令行运行 php-cs-fixer fix。

aminurislamarnob / wp-php-cs-fixer

维护者

详细信息