tareq1988 / wp-php-cs-fixer
WordPress 规则 for php-cs-fixer
1.0.0
2022-08-26 09:36 UTC
This package is auto-updated.
Last update: 2024-09-19 09:00:11 UTC
README
一组针对 PHP CS Fixer 定制的修复器,特别适用于 WordPress。
什么是 php-cs-fixer?
由 php-cs-fixer 或 PHP Coding Standards Fixer 是由 Symfony 的超级棒的人创造的超级棒的工具。
它可以帮助您的 PHP 代码/仓库遵循您团队定义的某个编码标准。
什么是 WordPress 修复器?
WordPress 使用与其他世界略有不同的编码标准。它尚未遵循 PSR 标准。
这个 WordPress 特定修复器的目的是让 WordPress 开发者能够根据 WordPress 编码标准 标准化他们的代码。
可用的修复器
- 括号内的空格:此修复器确保在定义函数、if/else 块或具有括号的控件结构时,存在起始括号后的空格和结束括号前的空格。规则名称:
WeDevs/space_inside_parenthesis
。 - 类开头的空白行:PSR 标准要求类开括号在新一行,WordPress 遵循相同的行标准。这确保在开括号之后存在一个空白行(等于两个
\n
)。规则名称:WeDevs/blank_line_after_class_opening
。
安装
PHP CS Fixer:可以通过运行以下命令安装自定义修复器
composer require --dev tareq1988/wp-php-cs-fixer
用法
在您的 PHP CS Fixer 配置(.php-cs-fixer.dist.php
)中注册修复器并使用它们
<?php // add the custom fixers + require_once __DIR__ . '/vendor/tareq1988/wp-php-cs-fixer/loader.php'; $finder = PhpCsFixer\Finder::create() ->exclude('node_modules') ->exclude('vendors') ->in( __DIR__ ) ; $config = new PhpCsFixer\Config(); $config + ->registerCustomFixers([ + new WeDevs\Fixer\SpaceInsideParenthesisFixer(), + new WeDevs\Fixer\BlankLineAfterClassOpeningFixer() + ]) + ->setRules( WeDevs\Fixer\Fixer::rules() ) ->setFinder( $finder ) ; return $config;
WeDevs\Fixer\Fixer::rules()
函数简化了 WordPress 特定规则的使用。但是,如果您想有更多的控制,并且有不同的品味,您可以将 WeDevs\Fixer\Fixer
类中的规则复制/粘贴到 .php_cs
文件中。
示例文件
示例 .php_cs.example 文件应该是一个很好的插件起点。只需将文件放入您的插件文件夹中,并将其重命名为 .php-cs-fixer.dist.php
,然后您就可以开始了。
配置好一切后,从命令行运行 php-cs-fixer fix
。